Package org.daisy.braille.utils.impl.provider.braillo

Class BrailloEmbosserProvider

java.lang.Object

org.daisy.braille.utils.impl.provider.braillo.BrailloEmbosserProvider

All Implemented Interfaces:

EmbosserProvider, Provider<EmbosserFactoryProperties>

public class BrailloEmbosserProvider
extends Object
implements EmbosserProvider

TODO: write java doc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BrailloEmbosserProvider.EmbosserType	TODO: write java doc.

Constructor Summary

Constructors

Constructor	Description
BrailloEmbosserProvider()

Method Summary

Modifier and Type	Method	Description
Collection<EmbosserFactoryProperties>	list()	Lists all Factories.
Embosser	newFactory(String identifier)	Returns a new embosser with the specified identifier.
void	setCreatedWithSPI()	Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
void	setTableCatalog(TableCatalogService service)
void	unsetTableCatalog(TableCatalogService service)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrailloEmbosserProvider

public BrailloEmbosserProvider()

Method Detail

newFactory

public Embosser newFactory(String identifier)

Description copied from interface: EmbosserProvider

Returns a new embosser with the specified identifier.

Specified by:

newFactory in interface EmbosserProvider

Parameters:

identifier - the identifier

Returns:

returns a new embosser

list

public Collection<EmbosserFactoryProperties> list()

Description copied from interface: Provider

Lists all Factories.

Specified by:

list in interface Provider<EmbosserFactoryProperties>

Returns:

returns a collection of Factories

setTableCatalog

public void setTableCatalog(TableCatalogService service)

unsetTableCatalog

public void unsetTableCatalog(TableCatalogService service)

setCreatedWithSPI

public void setCreatedWithSPI()

Description copied from interface: EmbosserProvider

Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory. In other words, it was created using SPI (service provider interfaces).

This information, in turn, enables the implementation to use the same mechanism to set dependencies as needed.

If this information is not given, an implementation should avoid using SPIs and instead use declarative services for dependency injection as specified by OSGi. Note that this also applies to several newInstance() methods in the Java API.

The class that created an instance with SPI must call this method before putting it to use.

Specified by:

setCreatedWithSPI in interface EmbosserProvider