net.sf.mmm.util.lang.base

Class SimpleEnumProvider

java.lang.Object

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

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

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

net.sf.mmm.util.lang.base.SimpleEnumProvider

All Implemented Interfaces:

Iterable<EnumDefinition<?,?>>, EnumProvider

public class SimpleEnumProvider
extends AbstractEnumProvider

This is a simple implementation of EnumProvider. It only supports Boolean and any static Enum (where it dynamically creates definitions).

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.util.lang.base.AbstractEnumProvider

AbstractEnumProvider.EnumContainer

Constructor Summary

Constructors

Constructor and Description
SimpleEnumProvider() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	loadEnumValues(AbstractEnumProvider.EnumContainer container)
void	require(Runnable callback, EnumDefinition<?,?>... enumDefinitions) This method triggers that the given EnumDefinitions are available.

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

clear, doInitialize, getEnumContainer, getEnumDefinition, getEnumDefinition, getEnumDefinitions, getEnumDefinitionWithCategory, getEnumValue, getEnumValue, getEnumValues, getEnumValues, getStringUtil, isAvailable, isSupportEnumAutoRegistration, iterator, registerEnum, registerEnumDefinition, registerEnumDefinitions, require, setStringUtil

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 java.lang.Iterable

forEach, spliterator

Constructor Detail

SimpleEnumProvider

public SimpleEnumProvider()

The constructor.

Method Detail

require

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

Description copied from interface: EnumProvider

This method triggers that the given EnumDefinitions are available. In advanced to EnumProvider.require(EnumDefinition...) it allows to specify a callback that gets invoked after the required EnumDefinitions are available. This is useful in asynchronous environments (e.g. in client applications that have to receive the values (asynchronously) from the server).

Parameters:

callback - is a Runnable that will be called after all given EnumDefinitions are available.

enumDefinitions - are the EnumDefinitions of the required enumerations.

loadEnumValues

protected void loadEnumValues(AbstractEnumProvider.EnumContainer container)

Specified by:

loadEnumValues in class AbstractEnumProvider

Parameters:

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