org.jfree.xml.factory.objects

Interface ClassFactory

All Superinterfaces:
Serializable
Known Implementing Classes:
ArrayClassFactory, ClassFactoryCollector, ClassFactoryImpl, JavaBaseClassFactory, URLClassFactory

public interface ClassFactory
extends Serializable

A class factory.
Author:
Thomas Morgner

Method Summary

void
configure(Configuration config)
Configures this factory.
boolean
equals(Object o)
Compares whether two object factories are equal.
ObjectDescription
getDescriptionForClass(Class c)
Returns an object description for a class.
Iterator
getRegisteredClasses()
Returns an iterator for the registered classes.
ObjectDescription
getSuperClassObjectDescription(Class d, ObjectDescription knownSuperClass)
Returns an object description for the super class of a class.
int
hashCode()
Computes the hashCode for this ClassFactory.

Method Details

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.

Parameters:
config - the configuration, never null

equals

public boolean equals(Object o)
Compares whether two object factories are equal. This method must be implemented!
Parameters:
o - the other object.
Returns:
true, if both object factories describe the same objects, false otherwise.

getDescriptionForClass

public ObjectDescription getDescriptionForClass(Class c)
Returns an object description for a class.
Parameters:
c - the class.
Returns:
The object description.

getRegisteredClasses

public Iterator getRegisteredClasses()
Returns an iterator for the registered classes. This returns a list of pre-registered classes known to this ClassFactory. A class may be able to handle more than the registered classes.

This method exists to support query tools for UI design, do not rely on it for day to day work.

Returns:
The iterator.

getSuperClassObjectDescription

public ObjectDescription getSuperClassObjectDescription(Class d,
                                                        ObjectDescription knownSuperClass)
Returns an object description for the super class of a class.
Parameters:
d - the class.
knownSuperClass - the last known super class or null.
Returns:
The object description.

hashCode

public int hashCode()
Computes the hashCode for this ClassFactory. As equals() must be implemented, a corresponding hashCode() should be implemented as well.
Returns:
the hashcode.