Package org.daisy.factory
Interface Factory
-
- All Superinterfaces:
java.lang.Comparable<Factory>
- All Known Subinterfaces:
Embosser,FileFormat,Paper,Table,Validator
- All Known Implementing Classes:
AbstractEmbosser,AbstractFactory,AbstractPaper,AbstractTable,EmbosserTable,PEFValidator,RollPaper,SheetPaper,TractorPaper
public interface Factory extends java.lang.Comparable<Factory>
Provides an interface for common properties of a Factory.- Author:
- Joel HÃ¥kansson
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetDescription()Gets the description for this Factoryjava.lang.StringgetDisplayName()Gets the display name for this Factoryjava.lang.ObjectgetFeature(java.lang.String key)Gets the value of a feature used by this Factoryjava.lang.StringgetIdentifier()Gets the identifier for this Factoryjava.lang.ObjectgetProperty(java.lang.String key)Gets the value of a read-only property that applies to all objects returned by this Factory.voidsetFeature(java.lang.String key, java.lang.Object value)Sets a feature for new Objects returned by this Factory
-
-
-
Method Detail
-
getIdentifier
java.lang.String getIdentifier()
Gets the identifier for this Factory- Returns:
- returns the identifier for this Factory
-
getDisplayName
java.lang.String getDisplayName()
Gets the display name for this Factory- Returns:
- returns the display name for this Factory
-
getDescription
java.lang.String getDescription()
Gets the description for this Factory- Returns:
- returns the description for this Factory
-
getProperty
java.lang.Object getProperty(java.lang.String key)
Gets the value of a read-only property that applies to all objects returned by this Factory.- Parameters:
key- the name of the property to get- Returns:
- returns the value associated with this property or null if none is found
-
getFeature
java.lang.Object getFeature(java.lang.String key)
Gets the value of a feature used by this Factory- Parameters:
key- the key for the feature- Returns:
- returns the current value of the feature
- Throws:
java.lang.IllegalArgumentException- if the underlying implementation does not recognize the feature
-
setFeature
void setFeature(java.lang.String key, java.lang.Object value)Sets a feature for new Objects returned by this Factory- Parameters:
key- the key for the featurevalue- the value of the feature- Throws:
java.lang.IllegalArgumentException- if the underlying implementation does not recognize the feature
-
-