org.jfree.xml.generator.model

Class ClassDescription

public class ClassDescription extends Object

A description of a Java class.
Constructor Summary
ClassDescription(Class objectClass)
Creates a new class description.
Method Summary
CommentsgetComments()
Returns the comments for the class description.
TypeInfo[]getConstructorDescription()
Returns the constructor descriptions.
StringgetDescription()
Returns the description.
StringgetName()
Returns the class name.
ClassgetObjectClass()
Returns the object's class.
PropertyInfo[]getProperties()
Returns the info about properties.
PropertyInfogetProperty(String name)
Returns a property.
StringgetRegisterKey()
Returns the register key.
StringgetSource()
Returns the source for the class description.
ClassgetSuperClass()
Returns the super class.
booleanisPreserve()
Returns the preserve flag.
booleanisUndefined()
Returns true if the description is undefined.
voidsetComments(Comments comments)
Sets the comments for the class description.
voidsetConstructorDescription(TypeInfo[] constructorDescription)
Sets the constructor description.
voidsetDescription(String description)
Sets the description for the object.
voidsetPreserve(boolean preserve)
Sets the preserve flag.
voidsetProperties(PropertyInfo[] properties)
Sets the info about the class properties.
voidsetRegisterKey(String registerKey)
Sets the register key.
voidsetSource(String source)
Sets the source for the class description.
voidsetSuperClass(Class superClass)
Sets the super class.

Constructor Detail

ClassDescription

public ClassDescription(Class objectClass)
Creates a new class description.

Parameters: objectClass the class.

Method Detail

getComments

public Comments getComments()
Returns the comments for the class description.

Returns: The comments.

getConstructorDescription

public TypeInfo[] getConstructorDescription()
Returns the constructor descriptions.

Returns: the constructor descriptions.

getDescription

public String getDescription()
Returns the description.

Returns: the description.

getName

public String getName()
Returns the class name.

Returns: the class name.

getObjectClass

public Class getObjectClass()
Returns the object's class.

Returns: the object's class.

getProperties

public PropertyInfo[] getProperties()
Returns the info about properties.

Returns: the info about properties.

getProperty

public PropertyInfo getProperty(String name)
Returns a property.

Parameters: name the property name.

Returns: a property.

getRegisterKey

public String getRegisterKey()
Returns the register key.

Returns: the register key.

getSource

public String getSource()
Returns the source for the class description.

Returns: The source.

getSuperClass

public Class getSuperClass()
Returns the super class.

Returns: the super class.

isPreserve

public boolean isPreserve()
Returns the preserve flag.

Returns: a boolean.

isUndefined

public boolean isUndefined()
Returns true if the description is undefined.

Returns: a boolean.

setComments

public void setComments(Comments comments)
Sets the comments for the class description.

Parameters: comments the comments.

setConstructorDescription

public void setConstructorDescription(TypeInfo[] constructorDescription)
Sets the constructor description.

Parameters: constructorDescription the constructor description.

setDescription

public void setDescription(String description)
Sets the description for the object.

Parameters: description the description.

setPreserve

public void setPreserve(boolean preserve)
Sets the preserve flag.

Parameters: preserve the new value of the flag.

setProperties

public void setProperties(PropertyInfo[] properties)
Sets the info about the class properties.

Parameters: properties the properties.

setRegisterKey

public void setRegisterKey(String registerKey)
Sets the register key.

Parameters: registerKey the register key.

setSource

public void setSource(String source)
Sets the source for the class description.

Parameters: source the source.

setSuperClass

public void setSuperClass(Class superClass)
Sets the super class.

Parameters: superClass the super class.