Package org.apache.commons.chain.impl

Class CatalogFactoryBase<C extends Context>

java.lang.Object

org.apache.commons.chain.CatalogFactory<C>

org.apache.commons.chain.impl.CatalogFactoryBase<C>

Type Parameters:

C - Type of the context associated with this command

public class CatalogFactoryBase<C extends Context>
extends CatalogFactory<C>

A simple implementation of CatalogFactory.

Version:

$Revision$ $Date$

Author:

Sean Schofield

Field Summary

Fields inherited from class org.apache.commons.chain.CatalogFactory

DELIMITER

Constructor Summary

Constructors

Constructor	Description
CatalogFactoryBase()	Construct an empty instance of CatalogFactoryBase.

Method Summary

Modifier and Type	Method	Description
void	addCatalog(String name, Catalog<C> catalog)	Adds a named instance of Catalog to the factory (for subsequent retrieval later).
Catalog<C>	getCatalog()	Gets the default instance of Catalog associated with the factory (if any); otherwise, return null.
Catalog<C>	getCatalog(String name)	Retrieves a Catalog instance by name (if any); otherwise return null.
Iterator<String>	getNames()	Return an Iterator over the set of named Catalogs known to this CatalogFactory.
void	setCatalog(Catalog<C> catalog)	Sets the default instance of Catalog associated with the factory.

Methods inherited from class org.apache.commons.chain.CatalogFactory

clear, getCommand, getInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CatalogFactoryBase

public CatalogFactoryBase()

Construct an empty instance of CatalogFactoryBase. This constructor is intended solely for use by CatalogFactory.

Method Details

getCatalog

public Catalog<C> getCatalog()

Gets the default instance of Catalog associated with the factory (if any); otherwise, return null.

Specified by:

getCatalog in class CatalogFactory<C extends Context>

Returns:

the default Catalog instance

setCatalog

public void setCatalog(Catalog<C> catalog)

Sets the default instance of Catalog associated with the factory.

Specified by:

setCatalog in class CatalogFactory<C extends Context>

Parameters:

catalog - the default Catalog instance

getCatalog

public Catalog<C> getCatalog(String name)

Retrieves a Catalog instance by name (if any); otherwise return null.

Specified by:

getCatalog in class CatalogFactory<C extends Context>

Parameters:

name - the name of the Catalog to retrieve

Returns:

the specified Catalog

addCatalog

public void addCatalog(String name,
 Catalog<C> catalog)

Adds a named instance of Catalog to the factory (for subsequent retrieval later).

Specified by:

addCatalog in class CatalogFactory<C extends Context>

Parameters:

name - the name of the Catalog to add

catalog - the Catalog to add

getNames

public Iterator<String> getNames()

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

Specified by:

getNames in class CatalogFactory<C extends Context>

Returns:

An Iterator of the names of the Catalogs known by this factory.