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)
static <T> List<T>	getValuesFromType(Class<T> enumClass)	Returns the values that are defined in the type, if any.
boolean	isExtensible()	Whether the enum's values can be extended in an enum content provided in a IRuntimeRepository.
String	toString()
void	validate(MessageList list, IValidationContext context, Object enumValue)	Validates this enum's configuration in the given enum value against the model.
void	validate(MessageList list, IValidationContext context, List<?> enumValues)	Validates this enum's configuration in the given enum values against the model.

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

createMessageHelper, getDeprecation, getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, 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.

getValuesFromType

public static <T> List<T> getValuesFromType(Class<T> enumClass)

Returns the values that are defined in the type, if any. Values defined in an enum content are not returned here but must be retrieved via IRuntimeRepository.getEnumValues(Class).

Parameters:

enumClass - The class of which you want to get the enumeration values

Returns:

A list of instances of enumClass that are defined as enumeration values of the specified type.

Since:

25.1

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

validate

public void validate(MessageList list,
 IValidationContext context,
 List<?> enumValues)

Validates this enum's configuration in the given enum values against the model.

Parameters:

list - a MessageList, to which validation messages may be added

context - the IValidationContext, needed to determine the Locale in which to create Messages

enumValues - the enum value instances to validate

Throws:

IllegalArgumentException - if any of the given enum values does not match this enum type

Since:

25.1

validate

public void validate(MessageList list,
 IValidationContext context,
 Object enumValue)

Validates this enum's configuration in the given enum value against the model. Only properties inherent to an enum value (like mandatory) are validated here, properties that can only be validated in context with other enum values like unique are only validated in validate(MessageList, IValidationContext, List) (which also calls this validation for every enum value).

Parameters:

list - a MessageList, to which validation messages may be added

context - the IValidationContext, needed to determine the Locale in which to create Messages

enumValue - the enum value instances to validate

Throws:

IllegalArgumentException - if the given enum value does not match this enum type

Since:

25.1

See Also:

• validate(MessageList, IValidationContext, List)
• EnumAttribute.validate(MessageList, IValidationContext, Object)