Package org.daisy.dotify.api.factory

Class AbstractFactory

java.lang.Object

org.daisy.dotify.api.factory.AbstractFactory

All Implemented Interfaces:

Serializable, Factory, FactoryProperties

Direct Known Subclasses:

AbstractEmbosser, AbstractTable, BrailleEditorsFileFormat

public abstract class AbstractFactory
extends Object
implements Factory, Serializable

Provides an abstract class for Factories.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.daisy.dotify.api.factory.FactoryProperties

FactoryProperties.ComparatorBuilder

Constructor Summary

Constructors

Constructor	Description
AbstractFactory(String name, String desc, String identifier)	Creates a new AbstractFactory with the supplied values.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description for this Factory.
String	getDisplayName()	Gets the display name for this Factory.
String	getIdentifier()	Gets the identifier for this Factory.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.daisy.dotify.api.factory.Factory

getFeature, getProperty, setFeature

Constructor Detail

AbstractFactory

public AbstractFactory(String name,
                       String desc,
                       String identifier)

Creates a new AbstractFactory with the supplied values. It is currently possible to supply a null identifier, however this will throw a null pointer exception in future versions.

Parameters:

name - the factory name

desc - the factory description

identifier - the factory identifier

Method Detail

getDescription

public String getDescription()

Description copied from interface: FactoryProperties

Gets the description for this Factory.

Specified by:

getDescription in interface FactoryProperties

Returns:

returns the description for this Factory

getDisplayName

public String getDisplayName()

Description copied from interface: FactoryProperties

Gets the display name for this Factory.

Specified by:

getDisplayName in interface FactoryProperties

Returns:

returns the display name for this Factory

getIdentifier

public String getIdentifier()

Description copied from interface: FactoryProperties

Gets the identifier for this Factory.

Specified by:

getIdentifier in interface FactoryProperties

Returns:

returns the identifier for this Factory

toString

public String toString()

Overrides:

toString in class Object