org.codehaus.modello.model

Class BaseElement

Known Direct Subclasses:
CodeSegment, Model, ModelClass, ModelField, ModelInterface

public abstract class BaseElement
extends java.lang.Object

This is the base class for all elements of the model. The name attribute is immutable because it's used as the key.
Version:
$Id: BaseElement.java 360 2005-06-12 10:39:57Z trygvis $
Authors:
Jason van Zyl
Trygve Laugstøl
Emmanuel Venisse

Constructor Summary

BaseElement(boolean nameRequired)
BaseElement(boolean nameRequired, String name)

Method Summary

void
addMetadata(Metadata metadata)
boolean
equals(Object other)
String
getComment()
Version
getDeprecatedVersion()
String
getDescription()
protected Metadata
getMetadata(Class type, String key)
String
getName()
VersionRange
getVersionRange()
boolean
hasMetadata(String key)
int
hashCode()
protected boolean
isEmpty(String string)
void
setComment(String comment)
void
setDeprecatedVersion(Version deprecatedVersion)
void
setDescription(String description)
void
setName(String name)
void
setVersionRange(VersionRange versionRange)
void
validate()
abstract void
validateElement()
protected void
validateFieldNotEmpty(String objectName, String fieldName, String value)

Constructor Details

BaseElement

public BaseElement(boolean nameRequired)

BaseElement

public BaseElement(boolean nameRequired,
                   String name)

Method Details

addMetadata

public void addMetadata(Metadata metadata)

equals

public boolean equals(Object other)

getComment

public String getComment()

getDeprecatedVersion

public Version getDeprecatedVersion()

getDescription

public String getDescription()

getMetadata

protected Metadata getMetadata(Class type,
                               String key)

getName

public String getName()

getVersionRange

public VersionRange getVersionRange()

hasMetadata

public boolean hasMetadata(String key)

hashCode

public int hashCode()

isEmpty

protected boolean isEmpty(String string)

setComment

public void setComment(String comment)

setDeprecatedVersion

public void setDeprecatedVersion(Version deprecatedVersion)

setDescription

public void setDescription(String description)

setName

public void setName(String name)

setVersionRange

public void setVersionRange(VersionRange versionRange)

validate

public final void validate()
            throws ModelValidationException

validateElement

public abstract void validateElement()
            throws ModelValidationException

validateFieldNotEmpty

protected void validateFieldNotEmpty(String objectName,
                                     String fieldName,
                                     String value)
            throws ModelValidationException