Package org.codehaus.modello.model

Class ModelClass

java.lang.Object

org.codehaus.modello.model.BaseElement

org.codehaus.modello.model.ModelType

org.codehaus.modello.model.ModelClass

public class ModelClass
extends ModelType

Author:

Jason van Zyl, Emmanuel Venisse

Constructor Summary

Constructors

Constructor	Description
ModelClass()
ModelClass(Model model, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addField(ModelField modelField)
void	addInterface(java.lang.String modelInterface)
boolean	equals(java.lang.Object o)
java.util.List<ModelField>	getAllFields()	Returns the list of all fields in this class.
java.util.List<ModelField>	getAllFields(boolean withInheritedField)	Returns all the fields in this class and all super classes if withInheritedField equals to true.
ModelField	getField(java.lang.String type, VersionRange versionRange)
java.util.List<java.lang.String>	getInterfaces()	Returns the list of all interfaces of this class.
ClassMetadata	getMetadata(java.lang.String key)
java.lang.String	getSuperClass()
int	hashCode()
boolean	hasSuperClass()
void	initialize(Model model)
boolean	isInternalSuperClass()
void	setSuperClass(java.lang.String superClass)
void	validateElement()

Methods inherited from class org.codehaus.modello.model.BaseElement

addMetadata, getAnnotations, getComment, getDeprecatedVersion, getDescription, getMetadata, getName, getVersionRange, hasMetadata, isEmpty, setAnnotations, setComment, setDeprecatedVersion, setDescription, setName, setVersionRange, validate, validateFieldNotEmpty

Methods inherited from class org.codehaus.modello.model.ModelType

addCodeSegment, getAllCodeSegments, getAllFields, getCodeSegments, getCodeSegments, getField, getFields, getIdentifierFields, getModel, getPackageName, getPackageName, hasField, setPackageName

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelClass

public ModelClass()

ModelClass

public ModelClass(Model model,
                  java.lang.String name)

Method Detail

getSuperClass

public java.lang.String getSuperClass()

setSuperClass

public void setSuperClass(java.lang.String superClass)

getInterfaces

public java.util.List<java.lang.String> getInterfaces()

Returns the list of all interfaces of this class.

Returns:

Returns the list of all interfaces of this class.

addInterface

public void addInterface(java.lang.String modelInterface)

getAllFields

public java.util.List<ModelField> getAllFields()

Returns the list of all fields in this class. It does not include the fields of super classes.

Specified by:

getAllFields in class ModelType

Returns:

Returns the list of all fields in this class. It does not include the fields of super classes.

getAllFields

public java.util.List<ModelField> getAllFields(boolean withInheritedField)

Returns all the fields in this class and all super classes if withInheritedField equals to true.

Specified by:

getAllFields in class ModelType

Parameters:

withInheritedField - whether inherited fields should be included.

Returns:

Returns all the fields in this class and all super classes.

getField

public ModelField getField(java.lang.String type,
                           VersionRange versionRange)

Specified by:

getField in class ModelType

addField

public void addField(ModelField modelField)

hasSuperClass

public boolean hasSuperClass()

isInternalSuperClass

public boolean isInternalSuperClass()

getMetadata

public ClassMetadata getMetadata(java.lang.String key)

initialize

public void initialize(Model model)

Overrides:

initialize in class ModelType

validateElement

public void validateElement()
                     throws ModelValidationException

Specified by:

validateElement in class BaseElement

Throws:

ModelValidationException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class BaseElement

hashCode

public int hashCode()

Overrides:

hashCode in class BaseElement