net.sf.mmm.util.lang.base

Class AbstractEnumDefinition<TYPE,CATEGORY>

java.lang.Object

net.sf.mmm.util.lang.base.AbstractEnumDefinition<TYPE,CATEGORY>

Type Parameters:

TYPE - is the generic type of the enum type.

CATEGORY - is the generic type of the category or Void for none.

All Implemented Interfaces:

Serializable, AttributeReadValue<String>, Datatype, EnumDefinition<TYPE,CATEGORY>, SimpleDatatype<String>

Direct Known Subclasses:

AbstractSimpleEnumDefinition, EnumEnumDefinition

public abstract class AbstractEnumDefinition<TYPE,CATEGORY>
extends Object
implements EnumDefinition<TYPE,CATEGORY>

This class implements EnumDefinition for a java Enum.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Formatter<TYPE>	formatter
private static long	serialVersionUID UID for serialization.

Constructor Summary

Constructors

Constructor and Description
AbstractEnumDefinition() The constructor.

Method Summary

Modifier and Type	Method and Description
List<TYPE>	getEnumValues()
Formatter<TYPE>	getFormatter() This method gets the Formatter used to format instances of the enum as String for end-users.
protected String	getKey(Class<TYPE> type) This method is called from the constructor to set the value.
String	getValue() This method returns the raw value of this datatype.
boolean	isCachable()
boolean	isMutable()
protected void	setFormatter(Formatter<TYPE> formatter)
String	toString() Returns the official String representation of this Datatype.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.lang.api.EnumDefinition

getCategory, getEnumType

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

formatter

private Formatter<TYPE> formatter

See Also:

getFormatter()

Constructor Detail

AbstractEnumDefinition

public AbstractEnumDefinition()

The constructor.

Method Detail

getKey

protected String getKey(Class<TYPE> type)

This method is called from the constructor to set the value. By default it returns Class.getName(). Override to change (e.g. to Class.getSimpleName()).

Parameters:

type - is the EnumDefinition.getEnumType().

Returns:

the getValue() to use.

getFormatter

public final Formatter<TYPE> getFormatter()

This method gets the Formatter used to format instances of the enum as String for end-users. By default FormatterToString can be used. However, e.g. for the type Boolean you might want to display as "yes" or "no" and might have an alternative EnumDefinition for Boolean that displays as "all" or "none". Further, also I18N (see NlsMessage) can be addressed by this Formatter. ATTENTION:
A EnumDefinition may be used with or without allowing a null value. Therefore, this Formatter should be able to properly format null (see AbstractFormatter#formatNull()). E.g. a Boolean option in a search form may be optional and displayed as "any".

Specified by:

getFormatter in interface EnumDefinition<TYPE,CATEGORY>

Returns:

the Formatter.

setFormatter

protected void setFormatter(Formatter<TYPE> formatter)

Parameters:

formatter - is the new value of getFormatter().

getValue

public String getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String, Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).
ATTENTION:
The value is used as identifier for this enum type and has to be unique for all available enumerations.

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface EnumDefinition<TYPE,CATEGORY>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

toString

public String toString()

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Object

Returns:

the official String representation to display the value of this Datatype.

getEnumValues

public List<TYPE> getEnumValues()

Returns:

the List of the enum values or null if the values are NOT static and have to be loaded asynchronous via EnumProvider.

isMutable

public boolean isMutable()

Specified by:

isMutable in interface EnumDefinition<TYPE,CATEGORY>

Returns:

true if EnumType-instances of this type can be added or removed, false otherwise (e.g. if implemented by a Enum).

isCachable

public boolean isCachable()

Specified by:

isCachable in interface EnumDefinition<TYPE,CATEGORY>

Returns:

true if all EnumType-instances of this type can cached (default) or false if there are too many of them (e.g. for entities like cities of the world).