Package org.codehaus.modello.model
Class BaseElement
- java.lang.Object
-
- org.codehaus.modello.model.BaseElement
-
- Direct Known Subclasses:
CodeSegment
,Model
,ModelField
,ModelType
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.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<java.lang.String>
annotations
private java.lang.String
comment
private Version
deprecatedVersion
private java.lang.String
description
private java.util.Map<java.lang.String,Metadata>
metadata
private java.lang.String
name
private boolean
nameRequired
private VersionRange
versionRange
-
Constructor Summary
Constructors Constructor Description BaseElement(boolean nameRequired)
BaseElement(boolean nameRequired, java.lang.String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addMetadata(Metadata metadata)
boolean
equals(java.lang.Object other)
java.util.List<java.lang.String>
getAnnotations()
java.lang.String
getComment()
Version
getDeprecatedVersion()
java.lang.String
getDescription()
protected <T extends Metadata>
TgetMetadata(java.lang.Class<T> type, java.lang.String key)
java.lang.String
getName()
VersionRange
getVersionRange()
int
hashCode()
boolean
hasMetadata(java.lang.String key)
protected boolean
isEmpty(java.lang.String string)
void
setAnnotations(java.util.List<java.lang.String> annotations)
void
setComment(java.lang.String comment)
void
setDeprecatedVersion(Version deprecatedVersion)
void
setDescription(java.lang.String description)
void
setName(java.lang.String name)
void
setVersionRange(VersionRange versionRange)
void
validate()
abstract void
validateElement()
protected void
validateFieldNotEmpty(java.lang.String objectName, java.lang.String fieldName, java.lang.String value)
-
-
-
Field Detail
-
name
private java.lang.String name
-
description
private java.lang.String description
-
comment
private java.lang.String comment
-
annotations
private java.util.List<java.lang.String> annotations
-
versionRange
private VersionRange versionRange
-
deprecatedVersion
private Version deprecatedVersion
-
metadata
private transient java.util.Map<java.lang.String,Metadata> metadata
-
nameRequired
private boolean nameRequired
-
-
Method Detail
-
validateElement
public abstract void validateElement() throws ModelValidationException
- Throws:
ModelValidationException
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
getDescription
public java.lang.String getDescription()
-
setDescription
public void setDescription(java.lang.String description)
-
getVersionRange
public VersionRange getVersionRange()
-
setVersionRange
public void setVersionRange(VersionRange versionRange)
-
setDeprecatedVersion
public void setDeprecatedVersion(Version deprecatedVersion)
-
getDeprecatedVersion
public Version getDeprecatedVersion()
-
getComment
public java.lang.String getComment()
-
setComment
public void setComment(java.lang.String comment)
-
hasMetadata
public boolean hasMetadata(java.lang.String key)
-
addMetadata
public void addMetadata(Metadata metadata)
-
getMetadata
protected <T extends Metadata> T getMetadata(java.lang.Class<T> type, java.lang.String key)
-
validateFieldNotEmpty
protected void validateFieldNotEmpty(java.lang.String objectName, java.lang.String fieldName, java.lang.String value) throws ModelValidationException
- Throws:
ModelValidationException
-
validate
public final void validate() throws ModelValidationException
- Throws:
ModelValidationException
-
isEmpty
protected boolean isEmpty(java.lang.String string)
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getAnnotations
public java.util.List<java.lang.String> getAnnotations()
- Returns:
- the annotations
-
setAnnotations
public void setAnnotations(java.util.List<java.lang.String> annotations)
- Parameters:
annotations
- the annotations to set
-
-