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

Class BrailleEditorsFileFormatProvider

java.lang.Object

org.daisy.braille.utils.impl.provider.BrailleEditorsFileFormatProvider

All Implemented Interfaces:

FileFormatProvider, Provider<FactoryProperties>

public class BrailleEditorsFileFormatProvider
extends Object
implements FileFormatProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BrailleEditorsFileFormatProvider.FileType	TODO: write java doc.

Constructor Summary

Constructors

Constructor	Description
BrailleEditorsFileFormatProvider()

Method Summary

Modifier and Type	Method	Description
Collection<FactoryProperties>	list()	Lists all Factories.
FileFormat	newFactory(String identifier)	Creates a new file format 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

BrailleEditorsFileFormatProvider

public BrailleEditorsFileFormatProvider()

Method Detail

list

public Collection<FactoryProperties> list()

Description copied from interface: Provider

Lists all Factories.

Specified by:

list in interface Provider<FactoryProperties>

Returns:

returns a collection of Factories

newFactory

public FileFormat newFactory(String identifier)

Description copied from interface: FileFormatProvider

Creates a new file format with the specified identifier.

Specified by:

newFactory in interface FileFormatProvider

Parameters:

identifier - the identifier

Returns:

returns a new file format

setTableCatalog

public void setTableCatalog(TableCatalogService service)

unsetTableCatalog

public void unsetTableCatalog(TableCatalogService service)

setCreatedWithSPI

public void setCreatedWithSPI()

Description copied from interface: FileFormatProvider

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 FileFormatProvider