Package org.daisy.dotify.api.embosser

Class EmbosserCatalog

java.lang.Object

org.daisy.dotify.api.embosser.EmbosserCatalog

All Implemented Interfaces:

EmbosserCatalogService, FactoryCatalog<Embosser>

public class EmbosserCatalog
extends Object
implements FactoryCatalog<Embosser>, EmbosserCatalogService

Provides a catalog of Embosser factories.

Constructor Summary

Constructors

Constructor	Description
EmbosserCatalog()	Creates a new empty instance.

Method Summary

Modifier and Type	Method	Description
void	addFactory(EmbosserProvider factory)	Adds a factory (intended for use by the OSGi framework)
Embosser	get(String identifier)	Gets the Factory with this identifier
Collection<EmbosserFactoryProperties>	listEmbossers()	Lists embossers
Collection<EmbosserFactoryProperties>	listEmbossers(EmbosserFilter filter)	Lists embossers matching the specified filter
Embosser	newEmbosser(String identifier)	Creates a new embosser with the specified identifier.
static EmbosserCatalog	newInstance()	Creates a new EmbosserCatalog and populates it using the SPI (java service provider interface).
void	removeFactory(EmbosserProvider factory)	Removes a factory (intended for use by the OSGi framework)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbosserCatalog

public EmbosserCatalog()

Creates a new empty instance. This method is public because it is required by OSGi. In an SPI context, use newInstance()

Method Detail

newInstance

public static EmbosserCatalog newInstance()

Creates a new EmbosserCatalog and populates it using the SPI (java service provider interface).

In an OSGi context, an instance should be retrieved using the service registry. It will be registered under the EmbosserCatalogService interface.

Returns:

returns a new EmbosserCatalog

addFactory

public void addFactory(EmbosserProvider factory)

Adds a factory (intended for use by the OSGi framework)

Parameters:

factory - the factory to add

removeFactory

public void removeFactory(EmbosserProvider factory)

Removes a factory (intended for use by the OSGi framework)

Parameters:

factory - the factory to remove

get

public Embosser get(String identifier)

Description copied from interface: FactoryCatalog

Gets the Factory with this identifier

Specified by:

get in interface FactoryCatalog<Embosser>

Parameters:

identifier - the identifier for the requested Factory

Returns:

returns the Factory with this identifier, or null if none is found

newEmbosser

public Embosser newEmbosser(String identifier)

Description copied from interface: EmbosserCatalogService

Creates a new embosser with the specified identifier.

Specified by:

newEmbosser in interface EmbosserCatalogService

Parameters:

identifier - the identifier

Returns:

returns a new embosser, or null if not found

listEmbossers

public Collection<EmbosserFactoryProperties> listEmbossers()

Description copied from interface: EmbosserCatalogService

Lists embossers

Specified by:

listEmbossers in interface EmbosserCatalogService

Returns:

returns a list of embossers

listEmbossers

public Collection<EmbosserFactoryProperties> listEmbossers(EmbosserFilter filter)

Description copied from interface: EmbosserCatalogService

Lists embossers matching the specified filter

Specified by:

listEmbossers in interface EmbosserCatalogService

Parameters:

filter - the filter

Returns:

returns a list of embossers