ModelInterface

java.lang.Object

org.codehaus.modello.model.BaseElement

org.codehaus.modello.model.ModelType

org.codehaus.modello.model.ModelInterface

public class ModelInterface extends ModelType

Author:: Emmanuel Venisse

Constructor Summary

Constructors

Constructor

Description

ModelInterface()

ModelInterface(Model model, String name)
Method Summary

Modifier and Type

Method

Description

List<ModelField>

getAllFields()

Returns the list of all fields in this class.

List<ModelField>

getAllFields(boolean withInheritedField)

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

ModelField

getField(String type, VersionRange versionRange)

String

getSuperInterface()

void

setSuperInterface(String superInterface)

void

validateElement()

Methods inherited from class org.codehaus.modello.model.ModelType
addCodeSegment, getAllCodeSegments, getAllFields, getCodeSegments, getCodeSegments, getField, getFields, getIdentifierFields, getModel, getPackageName, getPackageName, hasField, initialize, setPackageName

Methods inherited from class org.codehaus.modello.model.BaseElement
addMetadata, equals, getAnnotations, getComment, getDeprecatedVersion, getDescription, getMetadata, getName, getVersionRange, hashCode, hasMetadata, isEmpty, setAnnotations, setComment, setDeprecatedVersion, setDescription, setName, setVersionRange, validate, validateFieldNotEmpty

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ModelInterface
  
  public ModelInterface()
- ModelInterface
  
  public ModelInterface(Model model, String name)
Method Details
- setSuperInterface
  
  public void setSuperInterface(String superInterface)
- getSuperInterface
  
  public String getSuperInterface()
- getAllFields
  
  public 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 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(String type, VersionRange versionRange)
  
  Specified by:
  
  getField in class ModelType
- validateElement
  
  public void validateElement() throws ModelValidationException
  
  Specified by:
  
  validateElement in class BaseElement
  
  Throws:
  
  ModelValidationException