net.sf.mmm.util.lang.base

Class AbstractEnumProvider

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.lang.base.AbstractEnumProvider

All Implemented Interfaces:

Iterable<EnumDefinition<?,?>>, EnumProvider

Direct Known Subclasses:

AbstractEnumProviderAsynchronous, AbstractEnumProviderSynchronous, SimpleEnumProvider

public abstract class AbstractEnumProvider
extends AbstractLoggableComponent
implements EnumProvider

This is the abstract base implementation of EnumProvider.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractEnumProvider.EnumContainer This inner class is a container for an EnumDefinition with its values.
private static class	AbstractEnumProvider.EnumDefinitionIterator

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,AbstractEnumProvider.EnumContainer>	enumContainerMap
private StringUtil	stringUtil

Constructor Summary

Constructors

Constructor and Description
AbstractEnumProvider() The constructor.
AbstractEnumProvider(MapFactory<?> mapFactory) The constructor.

Method Summary

Modifier and Type	Method and Description
void	clear(EnumDefinition<?,?> enumDefinition) This method clears the (potentially) cached enum values of the given EnumDefinition.
protected void	doInitialize() This method performs the actual initialization.
protected AbstractEnumProvider.EnumContainer	getEnumContainer(String key)
<TYPE> EnumDefinition<TYPE,?>	getEnumDefinition(Class<TYPE> enumType) This method gets the EnumDefinition with the given enumType.
EnumDefinition<?,?>	getEnumDefinition(String key) This method gets the EnumDefinition with the given key.
Iterator<EnumDefinition<?,?>>	getEnumDefinitions() This method gets an (unmodifiable) Iterator with all existing EnumDefinitions.
<CATEGORY,ENUM extends EnumTypeWithCategory<?,CATEGORY>> EnumDefinition<ENUM,CATEGORY>	getEnumDefinitionWithCategory(Class<? extends ENUM> enumType) This method gets the EnumDefinition with the given enumType.
<ENUM> ENUM	getEnumValue(Class<ENUM> enumType, String value, boolean required) This method gets the EnumType-instance of the given EnumDefinition identified by the given value.
<ENUM> ENUM	getEnumValue(EnumDefinition<ENUM,?> enumDefinition, String value, boolean required) This method gets the EnumType-instance of the given EnumDefinition identified by the given value.
<ENUM> List<ENUM>	getEnumValues(EnumDefinition<ENUM,?> enumDefinition) This method gets the List of EnumType-instances that represent the values of the given EnumDefinition.
<CATEGORY,ENUM extends EnumTypeWithCategory<?,CATEGORY>> List<ENUM>	getEnumValues(EnumDefinition<ENUM,CATEGORY> enumDefinition, CATEGORY... categories) This method gets the List of enum values filtered by the given categories.
protected StringUtil	getStringUtil()
boolean	isAvailable(EnumDefinition<?,?> enumDefinition) This method determines if the given EnumDefinition is available, so it is ensured that the enum values can be retrieved.
protected boolean	isSupportEnumAutoRegistration()
Iterator<EnumDefinition<?,?>>	iterator() The same as EnumProvider.getEnumDefinitions().
protected abstract void	loadEnumValues(AbstractEnumProvider.EnumContainer container)
private String	normalizeStringRepresentation(String value) Normalizes the given String.
protected <ENUM extends Enum<ENUM>> void	registerEnum(Class<ENUM> enumClass) This method registers the given enumClass as EnumDefinition.
protected void	registerEnumDefinition(AbstractEnumDefinition<?,?> enumDefinition) This method registers the given EnumDefinition.
protected void	registerEnumDefinitions() Registers the enum definitions to support.
void	require(EnumDefinition<?,?>... enumDefinitions) This method triggers that the given EnumDefinitions are available.
void	setStringUtil(StringUtil stringUtil)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

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

require

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

enumContainerMap

private final Map<String,AbstractEnumProvider.EnumContainer> enumContainerMap

See Also:

getEnumDefinition(String)

stringUtil

private StringUtil stringUtil

See Also:

getStringUtil()

Constructor Detail

AbstractEnumProvider

public AbstractEnumProvider()

The constructor.

AbstractEnumProvider

public AbstractEnumProvider(MapFactory<?> mapFactory)

The constructor.

Parameters:

mapFactory - is the MapFactory used to create internal Maps for cache or registration.

Method Detail

getStringUtil

protected StringUtil getStringUtil()

Returns:

the StringUtil instance.

setStringUtil

@Inject
public void setStringUtil(StringUtil stringUtil)

Parameters:

stringUtil - is the StringUtil to Inject.

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

registerEnumDefinitions

protected void registerEnumDefinitions()

Registers the enum definitions to support. Override this method to add custom EnumDefinitions or replace defaults.

iterator

public final Iterator<EnumDefinition<?,?>> iterator()

The same as EnumProvider.getEnumDefinitions().

Specified by:

iterator in interface Iterable<EnumDefinition<?,?>>

Specified by:

iterator in interface EnumProvider

getEnumDefinitions

public Iterator<EnumDefinition<?,?>> getEnumDefinitions()

This method gets an (unmodifiable) Iterator with all existing EnumDefinitions. In most cases this is a static list, however it may also be dynamic.

Specified by:

getEnumDefinitions in interface EnumProvider

Returns:

the Iterator with all existing EnumDefinitions.

See Also:

EnumProvider.iterator()

registerEnum

protected <ENUM extends Enum<ENUM>> void registerEnum(Class<ENUM> enumClass)

This method registers the given enumClass as EnumDefinition.

Type Parameters:

ENUM - is the generic type of the Enum.

Parameters:

enumClass - is the Enum to register.

registerEnumDefinition

protected void registerEnumDefinition(AbstractEnumDefinition<?,?> enumDefinition)

This method registers the given EnumDefinition.

Parameters:

enumDefinition - is the EnumDefinition to register.

See Also:

registerEnum(Class)

getEnumDefinitionWithCategory

public <CATEGORY,ENUM extends EnumTypeWithCategory<?,CATEGORY>> EnumDefinition<ENUM,CATEGORY> getEnumDefinitionWithCategory(Class<? extends ENUM> enumType)
                                                                                                                     throws ObjectNotFoundException

This method gets the EnumDefinition with the given enumType.

Specified by:

getEnumDefinitionWithCategory in interface EnumProvider

Type Parameters:

CATEGORY - is the generic for the category.

ENUM - is the generic for the enum type.

Parameters:

enumType - is the enum type of the requested definition.

Returns:

the requested EnumDefinition.

Throws:

ObjectNotFoundException - if no such EnumDefinition exists.

getEnumDefinition

public <TYPE> EnumDefinition<TYPE,?> getEnumDefinition(Class<TYPE> enumType)
                                                throws ObjectNotFoundException

This method gets the EnumDefinition with the given enumType.

Specified by:

getEnumDefinition in interface EnumProvider

Type Parameters:

TYPE - is the generic for the enum type.

Parameters:

enumType - is the enum type of the requested definition.

Returns:

the requested EnumDefinition.

Throws:

ObjectNotFoundException - if no such EnumDefinition exists.

isSupportEnumAutoRegistration

protected boolean isSupportEnumAutoRegistration()

Returns:

true to automatically registerEnum(Class) requested Enum types (default), false otherwise (override to disable).

getEnumContainer

protected AbstractEnumProvider.EnumContainer getEnumContainer(String key)

Parameters:

key - is the identifier of the requested AbstractEnumProvider.EnumContainer.

Returns:

the requested AbstractEnumProvider.EnumContainer.

getEnumDefinition

public EnumDefinition<?,?> getEnumDefinition(String key)
                                      throws ObjectNotFoundException

This method gets the EnumDefinition with the given key. To get the default EnumDefinition for a particular enum type you should use EnumProvider.getEnumDefinition(Class) instead. However, for the same enum type multiple EnumDefinitions can exists. The default definition should have the qualified name of the enum type while additional definitions should have more specific keys that do not clash with others (e.g. "java.lang.Boolean_All_None").

Specified by:

getEnumDefinition in interface EnumProvider

Parameters:

key - is the key of the requested definition.

Returns:

the requested EnumDefinition.

Throws:

ObjectNotFoundException - if no such EnumDefinition exists.

isAvailable

public boolean isAvailable(EnumDefinition<?,?> enumDefinition)

This method determines if the given EnumDefinition is available, so it is ensured that the enum values can be retrieved.

Specified by:

isAvailable in interface EnumProvider

Parameters:

enumDefinition - is the EnumDefinition to check.

Returns:

true if the enum values for the given EnumDefinition are available (already loaded / in cache), false otherwise.

getEnumValue

public <ENUM> ENUM getEnumValue(Class<ENUM> enumType,
                                String value,
                                boolean required)
                         throws IllegalCaseException

This method gets the EnumType-instance of the given EnumDefinition identified by the given value.

Specified by:

getEnumValue in interface EnumProvider

Type Parameters:

ENUM - is the generic for the enum type.

Parameters:

enumType - is the EnumType for which the value is requested.

value - is the string representation of the requested EnumType instance based on EnumDefinition.getFormatter().

required - - true if the requested EnumType-instance is required, false otherwise.

Returns:

the EnumType-instance. Will be null if value is null or if required is false and no such EnumType instance exists.

Throws:

IllegalCaseException - if required is true and no such EnumType instance exists.

getEnumValue

public <ENUM> ENUM getEnumValue(EnumDefinition<ENUM,?> enumDefinition,
                                String value,
                                boolean required)

This method gets the EnumType-instance of the given EnumDefinition identified by the given value.

Specified by:

getEnumValue in interface EnumProvider

Type Parameters:

ENUM - is the generic for the enum type.

Parameters:

enumDefinition - is the EnumDefinition for which the value is requested.

value - is the string representation of the requested EnumType instance based on EnumDefinition.getFormatter().

required - - true if the requested EnumType-instance is required, false otherwise.

Returns:

the EnumType-instance. Will be null if value is null or if required is false and no such EnumType instance exists.

normalizeStringRepresentation

private String normalizeStringRepresentation(String value)

Normalizes the given String.

Parameters:

value - is the value to normalize.

Returns:

the normalized value.

See Also:

StringUtil.toCamlCase(String), EnumEnumDefinition.EnumDefaultFormatter

getEnumValues

public <ENUM> List<ENUM> getEnumValues(EnumDefinition<ENUM,?> enumDefinition)

This method gets the List of EnumType-instances that represent the values of the given EnumDefinition. In case the enum type implements AttributeReadDeprecated the deprecated enum values will be excluded from the returned List.

Specified by:

getEnumValues in interface EnumProvider

Type Parameters:

ENUM - is the generic for the enum type.

Parameters:

enumDefinition - is the EnumDefinition for which the values are requested.

Returns:

the List of EnumTypes.

loadEnumValues

protected abstract void loadEnumValues(AbstractEnumProvider.EnumContainer container)

Parameters:

container - is the AbstractEnumProvider.EnumContainer for which the getEnumValues(EnumDefinition) should be loaded.

getEnumValues

public <CATEGORY,ENUM extends EnumTypeWithCategory<?,CATEGORY>> List<ENUM> getEnumValues(EnumDefinition<ENUM,CATEGORY> enumDefinition,
                                                                                         CATEGORY... categories)

This method gets the List of enum values filtered by the given categories. So only these enum values are returned that have a category

Specified by:

getEnumValues in interface EnumProvider

Type Parameters:

CATEGORY - is the generic type of the category type.

ENUM - is the generic for the enum type.

Parameters:

enumDefinition - is the EnumDefinition for which the values are requested.

categories - are the categories.

Returns:

the List of matching EnumTypes.

clear

public void clear(EnumDefinition<?,?> enumDefinition)

This method clears the (potentially) cached enum values of the given EnumDefinition. If the enum is dynamic it is NOT available (anymore) after this operation.

Specified by:

clear in interface EnumProvider

Parameters:

enumDefinition - is the EnumDefinition to clear.

require

public void require(EnumDefinition<?,?>... enumDefinitions)

This method triggers that the given EnumDefinitions are available.

Specified by:

require in interface EnumProvider

Parameters:

enumDefinitions - are the EnumDefinitions of the required enumerations.