Class CollectionObjectDescription

java.lang.Object

org.jfree.xml.factory.objects.AbstractObjectDescription

org.jfree.xml.factory.objects.CollectionObjectDescription

All Implemented Interfaces:

Serializable, Cloneable, ObjectDescription

public class CollectionObjectDescription
extends AbstractObjectDescription

An object description for simple collection objects, like java.util.List or java.util.Set.

Author:

Thomas Morgner

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CollectionObjectDescription(Class c)	Creates a list object description for the given collection class.

Method Summary

Modifier and Type	Method	Description
Object	createObject()	Creates an object based on the 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, getInstance, getObjectClass, getParameter, getUnconfiguredInstance, hashCode, setParameter, setParameterDefinition

Methods inherited from class Object

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

Constructor Details

CollectionObjectDescription

public CollectionObjectDescription(Class c)

Creates a list object description for the given collection class.

Throws ClassCastException if the given class is no collection instance.

Parameters:

c - the class of the collection implementation.

Method Details

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.

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.