Package org.apache.commons.chain

Interface Catalog

All Known Implementing Classes:
CatalogBase
public interface Catalog

A Catalog is a collection of named Commands (or Chains) that can be used to retrieve the set of commands that should be performed based on a symbolic identifier. Use of catalogs is optional, but convenient when there are multiple possible chains that can be selected and executed based on environmental conditions.

Version:
$Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
Author:
Craig R. McClanahan

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CATALOG_KEY
    A default context attribute for storing a default Catalog, provided as a convenience only.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCommand(String name, Command command)
    Add a new name and associated Command or Chain to the set of named commands known to this Catalog, replacing any previous command for that name.
    Command
    getCommand(String name)
    Return the Command or Chain associated with the specified name, if any; otherwise, return null.
    Iterator
    getNames()
    Return an Iterator over the set of named commands known to this Catalog.

  • Field Details

    • CATALOG_KEY

      static final String CATALOG_KEY

      A default context attribute for storing a default Catalog, provided as a convenience only.

      See Also:

  • Method Details

    • addCommand

      void addCommand(String name, Command command)

      Add a new name and associated Command or Chain to the set of named commands known to this Catalog, replacing any previous command for that name.

      Parameters:
      name - Name of the new command
      command - Command or Chain to be returned for later lookups on this name

    • getCommand

      Command getCommand(String name)

      Return the Command or Chain associated with the specified name, if any; otherwise, return null.

      Parameters:
      name - Name for which a Command or Chain should be retrieved
      Returns:
      The Command associated with the specified name.

    • getNames

      Iterator getNames()

      Return an Iterator over the set of named commands known to this Catalog. If there are no known commands, an empty Iterator is returned.

      Returns:
      An iterator of the names in this Catalog.