Class EnumType
- java.lang.Object
-
- org.faktorips.runtime.model.type.ModelElement
-
- org.faktorips.runtime.model.enumtype.EnumType
-
public class EnumType extends ModelElement
Description of an enum's attributes and extensibility.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringKIND_NAME
-
Constructor Summary
Constructors Constructor Description EnumType(java.lang.Class<?> enumTypeClass)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnumAttributegetAttribute(java.lang.String name)Returns the model for the attribute with the given name ornullif no such attribute exists.java.util.List<java.lang.String>getAttributenames()Returns the names of all this enum's attributes.java.util.List<EnumAttribute>getAttributes()Returns models for all this enum's attributesEnumAttributegetDisplayNameAttribute()The model for the attribute used to display an instance of this enum in human readable form.java.lang.Class<?>getEnumClass()Returns the class this enum type represents.java.lang.StringgetEnumContentQualifiedName()The qualified name an enum content extending this enum must have.EnumAttributegetIdAttribute()The model for the attribute used to uniquely identify an instance of this enum.protected MessagesHelpergetMessageHelper()protected java.lang.StringgetMessageKey(DocumentationKind messageType)booleanisExtensible()Whether the enum's values can be extended in an enum content provided in aIRuntimeRepository.java.lang.StringtoString()-
Methods inherited from class org.faktorips.runtime.model.type.ModelElement
createMessageHelper, getDeprecation, getDescription, getDocumentation, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, invokeField, invokeMethod, isDeprecated
-
-
-
-
Field Detail
-
KIND_NAME
public static final java.lang.String KIND_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
isExtensible
public boolean isExtensible()
Whether the enum's values can be extended in an enum content provided in aIRuntimeRepository.
-
getEnumContentQualifiedName
public java.lang.String getEnumContentQualifiedName()
The qualified name an enum content extending this enum must have.- See Also:
isExtensible()
-
getAttributes
public java.util.List<EnumAttribute> getAttributes()
Returns models for all this enum's attributes
-
getAttribute
public EnumAttribute getAttribute(java.lang.String name)
Returns the model for the attribute with the given name ornullif no such attribute exists.
-
getAttributenames
public java.util.List<java.lang.String> getAttributenames()
Returns the names of all this enum's attributes.
-
getIdAttribute
public EnumAttribute getIdAttribute()
The model for the attribute used to uniquely identify an instance of this enum.
-
getDisplayNameAttribute
public EnumAttribute getDisplayNameAttribute()
The model for the attribute used to display an instance of this enum in human readable form.
-
getMessageHelper
protected MessagesHelper getMessageHelper()
- Specified by:
getMessageHelperin classModelElement
-
getMessageKey
protected java.lang.String getMessageKey(DocumentationKind messageType)
- Specified by:
getMessageKeyin classModelElement
-
getEnumClass
public java.lang.Class<?> getEnumClass()
Returns the class this enum type represents.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classModelElement
-
-