| org.jfree.xml.factory.objects.ObjectDescription
All known Subclasses: org.jfree.xml.factory.objects.AbstractObjectDescription,
| ObjectDescription | | public interface ObjectDescription extends Serializable(Code) | | An interface for object descriptions.
author:
Thomas Morgner |
| configure | | public void configure(Configuration config)(Code) | | 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.
Parameters:
config - the configuration, never null |
| createObject | | public Object createObject()(Code) | | Creates an object based on the description.
The object. |
| equals | | public boolean equals(Object o)(Code) | | Compares whether two object descriptions are equal.
Parameters:
o - the other object. true, if both object desciptions describe the same object, false otherwise. |
| getInstance | | public ObjectDescription getInstance()(Code) | | 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.
A cloned instance. |
| getObjectClass | | public Class getObjectClass()(Code) | | Returns the object class.
The Class. |
| getParameter | | public Object getParameter(String name)(Code) | | Returns the value of a parameter.
Parameters:
name - the parameter name. The value. |
| getParameterDefinition | | public Class getParameterDefinition(String name)(Code) | | Returns a parameter definition. If the parameter is invalid, this
function returns null.
Parameters:
name - the definition name. The parameter class or null, if the parameter is not defined. |
| getParameterNames | | public Iterator getParameterNames()(Code) | | Returns an iterator the provides access to the parameter names. This
returns all _known_ parameter names, the object description may accept
additional parameters.
The iterator. |
| getUnconfiguredInstance | | public ObjectDescription getUnconfiguredInstance()(Code) | | 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.
A cloned instance. |
| hashCode | | public int hashCode()(Code) | | Computes the hashCode for this ClassFactory. As equals() must be implemented,
a corresponding hashCode() should be implemented as well.
the hashcode. |
| setParameter | | public void setParameter(String name, Object value)(Code) | | Sets the value of a parameter.
Parameters:
name - the parameter name.
Parameters:
value - the parameter value. |
| setParameterFromObject | | public void setParameterFromObject(Object o) throws ObjectFactoryException(Code) | | Sets the parameters of this description object to match the supplied object.
Parameters:
o - the object.
throws:
ObjectFactoryException - if there is a problem while reading theproperties of the given object. |
|
|