Package org.faktorips.runtime.model.enumtype

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 final String	KIND_NAME

Constructor Summary

Constructors

Constructor	Description
EnumType(Class<?> enumTypeClass)

Method Summary

Modifier and Type	Method	Description
Optional<EnumType>	findSuperEnumType()
EnumAttribute	getAttribute(String name)	Returns the model for the attribute with the given name or null if no such attribute exists.
List<String>	getAttributenames()	Returns the names of all this enum's attributes.
List<EnumAttribute>	getAttributes()	Returns models for all this enum's attributes
EnumAttribute	getDisplayNameAttribute()	The model for the attribute used to display an instance of this enum in human readable form.
protected String	getDocumentation(Locale locale, DocumentationKind type, String fallback)
Class<?>	getEnumClass()	Returns the class this enum type represents.
String	getEnumContentQualifiedName()	The qualified name an enum content extending this enum must have.
EnumAttribute	getIdAttribute()	The model for the attribute used to uniquely identify an instance of this enum.
protected MessagesHelper	getMessageHelper()
protected String	getMessageKey(DocumentationKind messageType)
boolean	isExtensible()	Whether the enum's values can be extended in an enum content provided in a IRuntimeRepository.
String	toString()

Methods inherited from class org.faktorips.runtime.model.type.ModelElement

createMessageHelper, getDeprecation, getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, invokeField, invokeMethod, isDeprecated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

KIND_NAME

public static final String KIND_NAME

See Also:

• Constant Field Values

Constructor Details

EnumType

public EnumType(Class<?> enumTypeClass)

Method Details

isExtensible

public boolean isExtensible()

Whether the enum's values can be extended in an enum content provided in a IRuntimeRepository.

getEnumContentQualifiedName

public String getEnumContentQualifiedName()

The qualified name an enum content extending this enum must have.

See Also:

• isExtensible()

getAttributes

public List<EnumAttribute> getAttributes()

Returns models for all this enum's attributes

getAttribute

public EnumAttribute getAttribute(String name)

Returns the model for the attribute with the given name or null if no such attribute exists.

getAttributenames

public List<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:

getMessageHelper in class ModelElement

getMessageKey

protected String getMessageKey(DocumentationKind messageType)

Specified by:

getMessageKey in class ModelElement

getEnumClass

public Class<?> getEnumClass()

Returns the class this enum type represents.

toString

public String toString()

Overrides:

toString in class ModelElement

findSuperEnumType

public Optional<EnumType> findSuperEnumType()

getDocumentation

protected String getDocumentation(Locale locale,
 DocumentationKind type,
 String fallback)

Overrides:

getDocumentation in class ModelElement