Package org.jfree.xml.factory.objects
Class AbstractObjectDescription
java.lang.Object
org.jfree.xml.factory.objects.AbstractObjectDescription
- All Implemented Interfaces:
Serializable
,Cloneable
,ObjectDescription
- Direct Known Subclasses:
ArrayObjectDescription
,BasicStrokeObjectDescription
,BeanObjectDescription
,BooleanObjectDescription
,ByteObjectDescription
,CharacterObjectDescription
,ClassLoaderObjectDescription
,CollectionObjectDescription
,ColorObjectDescription
,DateObjectDescription
,Dimension2DObjectDescription
,DimensionObjectDescription
,DoubleObjectDescription
,FloatObjectDescription
,IntegerObjectDescription
,Line2DObjectDescription
,LongObjectDescription
,Point2DObjectDescription
,Rectangle2DObjectDescription
,ShortObjectDescription
,StringObjectDescription
,URLObjectDescription
public abstract class AbstractObjectDescription
extends Object
implements ObjectDescription, Cloneable
An abstract base class for object descriptions.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Class
The class.private Configuration
The configuration for the object description.private HashMap
Storage for parameter definitions.private HashMap
Storage for parameters. -
Constructor Summary
ConstructorsConstructorDescriptionAbstractObjectDescription
(Class className) Creates a new object description. -
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration config) Configures this factory.static Class
Converts primitives to corresponding object class.boolean
Tests for equality.Returns the configuration for that object description.protected Iterator
Returns an iterator for the parameter names.Returns a cloned instance of the object description.Returns the class for the object.getParameter
(String name) Returns a parameter value.getParameterDefinition
(String name) Returns a parameter class.Returns an iterator for the parameter names.Returns a cloned instance of the object description.int
hashCode()
Returns a hash code for the object.void
setParameter
(String name, Object value) Sets a parameter.void
setParameterDefinition
(String name, Class obj) Sets the class for a parameter.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jfree.xml.factory.objects.ObjectDescription
createObject, setParameterFromObject
-
Field Details
-
className
The class. -
parameters
Storage for parameters. -
parameterDefs
Storage for parameter definitions. -
config
The configuration for the object description.
-
-
Constructor Details
-
AbstractObjectDescription
Creates a new object description.- Parameters:
className
- the class.
-
-
Method Details
-
getParameterDefinition
Returns a parameter class.- Specified by:
getParameterDefinition
in interfaceObjectDescription
- Parameters:
name
- the parameter definition.- Returns:
- The class.
-
setParameterDefinition
Sets the class for a parameter.- Parameters:
name
- the parameter name.obj
- the parameter class.
-
convertPrimitiveClass
Converts primitives to corresponding object class.- Parameters:
obj
- the class.- Returns:
- The class.
-
setParameter
Sets a parameter.- Specified by:
setParameter
in interfaceObjectDescription
- Parameters:
name
- the name.value
- the value.
-
getParameterNames
Returns an iterator for the parameter names.- Specified by:
getParameterNames
in interfaceObjectDescription
- Returns:
- The iterator.
-
getDefinedParameterNames
Returns an iterator for the parameter names.- Returns:
- The iterator.
-
getParameter
Returns a parameter value.- Specified by:
getParameter
in interfaceObjectDescription
- Parameters:
name
- the parameter name.- Returns:
- The parameter value.
-
getObjectClass
Returns the class for the object.- Specified by:
getObjectClass
in interfaceObjectDescription
- Returns:
- The class.
-
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.
The newly instantiated object description is not configured. If it need to be configured, then you have to call configure on it.
- Specified by:
getInstance
in interfaceObjectDescription
- Returns:
- A cloned instance.
-
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.
- Specified by:
getUnconfiguredInstance
in interfaceObjectDescription
- Returns:
- A cloned instance.
-
configure
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.
- Specified by:
configure
in interfaceObjectDescription
- Parameters:
config
- the configuration, never null
-
getConfig
Returns the configuration for that object description.- Returns:
- the configuration or null, if not yet set.
-
equals
Tests for equality.- Specified by:
equals
in interfaceObjectDescription
- Overrides:
equals
in classObject
- Parameters:
o
- the object to test.- Returns:
- A boolean.
-
hashCode
public int hashCode()Returns a hash code for the object.- Specified by:
hashCode
in interfaceObjectDescription
- Overrides:
hashCode
in classObject
- Returns:
- The hash code.
-