org.jfree.xml.factory.objects
Interface ObjectDescription
- Serializable
- AbstractObjectDescription, ArrayObjectDescription, BasicStrokeObjectDescription, BeanObjectDescription, BooleanObjectDescription, ByteObjectDescription, CharacterObjectDescription, ClassLoaderObjectDescription, CollectionObjectDescription, ColorObjectDescription, DateObjectDescription, DecimalFormatObjectDescription, Dimension2DObjectDescription, DimensionObjectDescription, DoubleObjectDescription, FloatObjectDescription, IntegerObjectDescription, Line2DObjectDescription, LongObjectDescription, Point2DObjectDescription, Rectangle2DObjectDescription, ShortObjectDescription, SimpleDateFormatObjectDescription, StringObjectDescription, URLObjectDescription
An interface for object descriptions.
configure
public void configure(Configuration config)
Configures this factory. The configuration contains several keys and
their defined values. The given reference to the configuration object
will remain valid until the report parsing or writing ends.
The configuration contents may change during the reporting.
config
- the configuration, never null
createObject
public Object createObject()
Creates an object based on the description.
equals
public boolean equals(Object o)
Compares whether two object descriptions are equal.
- true, if both object desciptions describe the same object, false otherwise.
getInstance
public ObjectDescription getInstance()
Returns a cloned instance of the object description. The contents
of the parameter objects collection are cloned too, so that any
already defined parameter value is copied to the new instance.
Parameter definitions are not cloned, as they are considered read-only.
getParameter
public Object getParameter(String name)
Returns the value of a parameter.
name
- the parameter name.
getParameterDefinition
public Class getParameterDefinition(String name)
Returns a parameter definition. If the parameter is invalid, this
function returns null.
name
- the definition name.
- The parameter class or null, if the parameter is not defined.
getParameterNames
public Iterator getParameterNames()
Returns an iterator the provides access to the parameter names. This
returns all _known_ parameter names, the object description may accept
additional parameters.
getUnconfiguredInstance
public ObjectDescription getUnconfiguredInstance()
Returns a cloned instance of the object description. The contents
of the parameter objects collection are cloned too, so that any
already defined parameter value is copied to the new instance.
Parameter definitions are not cloned, as they are considered read-only.
The newly instantiated object description is not configured. If it
need to be configured, then you have to call configure on it.
hashCode
public int hashCode()
Computes the hashCode for this ClassFactory. As equals() must be implemented,
a corresponding hashCode() should be implemented as well.
setParameter
public void setParameter(String name,
Object value)
Sets the value of a parameter.
name
- the parameter name.value
- the parameter value.