net.sf.mmm.util.lang.base

Class EnumEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

java.lang.Object

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

net.sf.mmm.util.lang.base.EnumEnumDefinition<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>

public class EnumEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>
extends AbstractEnumDefinition<TYPE,CATEGORY>

This class implements EnumDefinition for a java Enum.
ATTENTION:
Please only use this class to build an EnumProvider. From out-side use EnumProvider.getEnumDefinition(Class) instead.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EnumEnumDefinition.EnumDefaultFormatter The default Formatter for Enums.
protected class	EnumEnumDefinition.EnumTypeFormatter The default Formatter for Enums that implement SimpleDatatype.

Field Summary

Fields

Modifier and Type	Field and Description
private EnumDefinition<CATEGORY,?>	category
private Class<TYPE>	enumType
private List<TYPE>	enumValues
private static long	serialVersionUID UID for serialization.
private StringUtil	stringUtil
private String	title
private String	value

Constructor Summary

Constructors

Modifier	Constructor and Description
	EnumEnumDefinition(Class<TYPE> enumType, EnumDefinition<CATEGORY,?> category, StringUtil stringUtil) The constructor.
private	EnumEnumDefinition(Class<TYPE> enumType, NodeCycle<Class<?>> cycle, EnumDefinition<CATEGORY,?> category, StringUtil stringUtil) The constructor.
	EnumEnumDefinition(Class<TYPE> enumType, StringUtil stringUtil) The constructor.

Method Summary

Modifier and Type	Method and Description
EnumDefinition<CATEGORY,?>	getCategory()
Class<TYPE>	getEnumType()
List<TYPE>	getEnumValues()
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()
String	toString() Returns the official String representation of this Datatype.

Methods inherited from class net.sf.mmm.util.lang.base.AbstractEnumDefinition

getFormatter, setFormatter

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

value

private String value

See Also:

getValue()

title

private String title

See Also:

toString()

category

private EnumDefinition<CATEGORY,?> category

See Also:

getCategory()

enumType

private Class<TYPE extends Enum<TYPE>> enumType

See Also:

getEnumType()

enumValues

private List<TYPE extends Enum<TYPE>> enumValues

See Also:

getEnumValues()

stringUtil

private StringUtil stringUtil

See Also:

EnumEnumDefinition.EnumDefaultFormatter

Constructor Detail

EnumEnumDefinition

public EnumEnumDefinition(Class<TYPE> enumType,
                          StringUtil stringUtil)

The constructor. A potential category is automatically detected.

Parameters:

enumType - - see getEnumType().

stringUtil - is the StringUtil instance to use.

EnumEnumDefinition

public EnumEnumDefinition(Class<TYPE> enumType,
                          EnumDefinition<CATEGORY,?> category,
                          StringUtil stringUtil)

The constructor.

Parameters:

enumType - - see getEnumType().

category - is the explicit category (if not realized by an Enum or auto-detection not desired for other reasons).

stringUtil - is the StringUtil instance to use.

EnumEnumDefinition

private EnumEnumDefinition(Class<TYPE> enumType,
                           NodeCycle<Class<?>> cycle,
                           EnumDefinition<CATEGORY,?> category,
                           StringUtil stringUtil)

The constructor.

Parameters:

enumType - - see getEnumType().

cycle - is a NodeCycle instance to detect cyclic categories.

category - is the category or null for auto-detect / none.

stringUtil - is the StringUtil instance to use.

Method Detail

getKey

protected String getKey(Class<TYPE> type)

This method is called from the constructor to set the value. By default it returns the qualified name of getEnumType(). Override to change (e.g. to simple name).

Overrides:

getKey in class AbstractEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

Parameters:

type - is the getEnumType().

Returns:

the getValue() to use.

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 extends Enum<TYPE>,CATEGORY>

Specified by:

getValue in interface SimpleDatatype<String>

Overrides:

getValue in class AbstractEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

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 AbstractEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

Returns:

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

getCategory

public EnumDefinition<CATEGORY,?> getCategory()

Returns:

the EnumDefinition this EnumDefinition is categorized by or null for no category (then <CATEGORY> shall be bound to Void).

getEnumType

public Class<TYPE> getEnumType()

Returns:

the EnumType of this EnumDefinition.

getEnumValues

public List<TYPE> getEnumValues()

Overrides:

getEnumValues in class AbstractEnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

Returns:

the List of the enum values.

isMutable

public boolean isMutable()

Specified by:

isMutable in interface EnumDefinition<TYPE extends Enum<TYPE>,CATEGORY>

Overrides:

isMutable in class AbstractEnumDefinition<TYPE extends Enum<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 extends Enum<TYPE>,CATEGORY>

Overrides:

isCachable in class AbstractEnumDefinition<TYPE extends Enum<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).