Class ArrayObjectDescription

java.lang.Object

org.jfree.xml.factory.objects.AbstractObjectDescription

org.jfree.xml.factory.objects.ArrayObjectDescription

All Implemented Interfaces:

Serializable, Cloneable, ObjectDescription

public class ArrayObjectDescription
extends AbstractObjectDescription

Describes an Object- or primitive value array. This object description is not intended to be created outside the ArrayClassFactory.

Author:

Thomas Morgner

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArrayObjectDescription(Class c)	Constructs a new array objet description for the given array class.

Method Summary

Modifier and Type	Method	Description
Object	createObject()	Creates an object based on the description.
ObjectDescription	getInstance()	Returns a new instance of the object description.
Class	getParameterDefinition(String name)	Returns a parameter definition.
Iterator	getParameterNames()	Returns an iterator for the parameter names.
void	setParameterFromObject(Object o)	Sets the parameters of this description object to match the supplied object.

Methods inherited from class AbstractObjectDescription

configure, convertPrimitiveClass, equals, getConfig, getDefinedParameterNames, getObjectClass, getParameter, getUnconfiguredInstance, hashCode, setParameter, setParameterDefinition

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ArrayObjectDescription

public ArrayObjectDescription(Class c)

Constructs a new array objet description for the given array class.

Note: throws IllegalArgumentException if the given class is no array.

Parameters:

c - the array class object.

Method Details

createObject

public Object createObject()

Creates an object based on the description.

Returns:

The object.

setParameterFromObject

public void setParameterFromObject(Object o)
                            throws ObjectFactoryException

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 the properties of the given object.

getParameterDefinition

public Class getParameterDefinition(String name)

Returns a parameter definition. If the parameter is invalid, this function returns null.

Specified by:

getParameterDefinition in interface ObjectDescription

Overrides:

getParameterDefinition in class AbstractObjectDescription

Parameters:

name - the definition name.

Returns:

The parameter class or null, if the parameter is not defined.

getParameterNames

public Iterator getParameterNames()

Returns an iterator for the parameter names.

Specified by:

getParameterNames in interface ObjectDescription

Overrides:

getParameterNames in class AbstractObjectDescription

Returns:

The iterator.

getInstance

public ObjectDescription getInstance()

Returns a new instance of the object description.

Specified by:

getInstance in interface ObjectDescription

Overrides:

getInstance in class AbstractObjectDescription

Returns:

The object description.