Package org.faktorips.runtime.model.enumtype

Class EnumAttribute

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.enumtype.EnumAttribute

public class EnumAttribute
extends ModelElement

Description of an attribute of an EnumType.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSGCODE_MANDATORY_ATTRIBUTE_IS_EMPTY
static final String	MSGCODE_NOT_UNIQUE
protected static final String	MSGKEY_MANDATORY_ATTRIBUTE_IS_EMPTY
protected static final String	MSGKEY_MANDATORY_MULTILINGUAL_ATTRIBUTE_IS_EMPTY
protected static final String	MSGKEY_NOT_UNIQUE

Constructor Summary

Constructors

Constructor	Description
EnumAttribute(EnumType enumType, String name, Method getter)

Method Summary

Modifier and Type	Method	Description
protected static LinkedHashMap<String,EnumAttribute>	createFrom(EnumType enumType, Class<?> enumClass)
Optional<EnumAttribute>	findSuperEnumAttribute()
Class<?>	getDatatype()	The class for this attribute's values.
protected String	getDocumentation(Locale locale, DocumentationKind type, String fallback)
protected MessagesHelper	getMessageHelper()
protected String	getMessageKey(DocumentationKind messageType)
Object	getValue(Object enumValue)	Returns the value for this attribute from the enum value.
Object	getValue(Object enumValue, Locale locale)	Returns the value for this attribute from the enum value.
boolean	isDisplayName()	Whether this attribute is used to display an enum value for human readability.
boolean	isIdentifier()	Whether this attribute is used to identify an enum value.
boolean	isMandatory()	Whether this attribute's values are mandatory (no empty/null values allowed).
boolean	isMultilingual()	Whether the values of this attribute are dependent on Locale.
boolean	isUnique()	Whether this attribute's value is unique over all the enum's values.
void	validate(MessageList list, IValidationContext context, Object enumValue)	Validates this enum attribute's configuration in the given enum value 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, toString

Methods inherited from class java.lang.Object

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

Field Details

MSGCODE_MANDATORY_ATTRIBUTE_IS_EMPTY

public static final String MSGCODE_MANDATORY_ATTRIBUTE_IS_EMPTY

See Also:

• Constant Field Values

MSGCODE_NOT_UNIQUE

public static final String MSGCODE_NOT_UNIQUE

See Also:

• Constant Field Values

MSGKEY_MANDATORY_ATTRIBUTE_IS_EMPTY

protected static final String MSGKEY_MANDATORY_ATTRIBUTE_IS_EMPTY

See Also:

• Constant Field Values

MSGKEY_MANDATORY_MULTILINGUAL_ATTRIBUTE_IS_EMPTY

protected static final String MSGKEY_MANDATORY_MULTILINGUAL_ATTRIBUTE_IS_EMPTY

See Also:

• Constant Field Values

MSGKEY_NOT_UNIQUE

protected static final String MSGKEY_NOT_UNIQUE

See Also:

• Constant Field Values

Constructor Details

EnumAttribute

public EnumAttribute(EnumType enumType,
 String name,
 Method getter)

Method Details

getDatatype

public Class<?> getDatatype()

The class for this attribute's values.

isUnique

public boolean isUnique()

Whether this attribute's value is unique over all the enum's values.

isIdentifier

public boolean isIdentifier()

Whether this attribute is used to identify an enum value.

isDisplayName

public boolean isDisplayName()

Whether this attribute is used to display an enum value for human readability.

isMandatory

public boolean isMandatory()

Whether this attribute's values are mandatory (no empty/null values allowed).

getValue

public Object getValue(Object enumValue)

Returns the value for this attribute from the enum value. If the attribute is multilingual, the default Locale is used.

See Also:

• for getting a multilingual value for a specific locale

isMultilingual

public boolean isMultilingual()

Whether the values of this attribute are dependent on Locale.

getValue

public Object getValue(Object enumValue,
 Locale locale)

Returns the value for this attribute from the enum value. If the attribute is multilingual, the given locale is used, otherwise it is ignored.

See Also:

• for getting a locale independent value

getMessageKey

protected String getMessageKey(DocumentationKind messageType)

Specified by:

getMessageKey in class ModelElement

getMessageHelper

protected MessagesHelper getMessageHelper()

Specified by:

getMessageHelper in class ModelElement

createFrom

protected static LinkedHashMap<String,EnumAttribute> createFrom(EnumType enumType,
 Class<?> enumClass)

findSuperEnumAttribute

public Optional<EnumAttribute> findSuperEnumAttribute()

getDocumentation

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

Overrides:

getDocumentation in class ModelElement

validate

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

Validates this enum attribute'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 validated in EnumType.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 instance to validate

Since:

25.1

See Also:

• EnumType.validate(MessageList, IValidationContext, List)