Package com.github.toolarium.enumeration.configuration.store.impl

Class EnumConfigurationKeyResolver

java.lang.Object

com.github.toolarium.enumeration.configuration.store.impl.EnumConfigurationKeyResolver

All Implemented Interfaces:

IEnumConfigurationKeyResolver

public class EnumConfigurationKeyResolver
extends java.lang.Object
implements IEnumConfigurationKeyResolver

Implements the IEnumConfigurationKeyResolver.

Constructor Summary

Constructors

Constructor	Description
EnumConfigurationKeyResolver()	Constructor for EnumConfigurationKeyResolver
EnumConfigurationKeyResolver(IEnumConfigurationResourceResolver enumConfigurationResourceResolver)	Constructor for EnumConfigurationKeyResolver
EnumConfigurationKeyResolver(IEnumConfigurationResourceResolver enumConfigurationResourceResolver, boolean ignoreCase)	Constructor for EnumConfigurationKeyResolver

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clear cache
protected <T extends java.lang.Enum<T>> T	convertToConfigurationKey(java.lang.String configurationKeyName)	Convert the unique configuration key name into an enum configuration key type
protected <T extends java.lang.Enum<T>> java.lang.String	convertToConfigurationKeyName(T configurationKey)	Convert configuration key type into a unique configuration key name
java.lang.String	createConfigurationKeyName(java.lang.String configurationName, java.lang.String keyName)	Create the configuration key name
protected java.lang.String	getConfigurationKeySeparator()	Get the configuration key separator
EnumKeyValueConfiguration	getEnumKeyValueConfiguration(java.lang.String inputConfigurationKeyName)	Get the enum key / value configuration information of an enum configuration name / key.
<T extends java.lang.Enum<T>> T	resolveConfigurationKey(java.lang.String configurationKeyName)	Resolves the configuration key
<T extends java.lang.Enum<T>> java.lang.String	resolveConfigurationKeyName(T configurationKey)	Resolves the configuration key name
protected java.lang.String[]	splitKeyName(java.lang.String inputConfigurationKeyName)	Split the key name

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumConfigurationKeyResolver

public EnumConfigurationKeyResolver()

Constructor for EnumConfigurationKeyResolver

EnumConfigurationKeyResolver

public EnumConfigurationKeyResolver(IEnumConfigurationResourceResolver enumConfigurationResourceResolver)

Constructor for EnumConfigurationKeyResolver

Parameters:

enumConfigurationResourceResolver - the enum configuration resource resolver

EnumConfigurationKeyResolver

public EnumConfigurationKeyResolver(IEnumConfigurationResourceResolver enumConfigurationResourceResolver,
                                    boolean ignoreCase)

Constructor for EnumConfigurationKeyResolver

Parameters:

enumConfigurationResourceResolver - the enum configuration resource resolver

ignoreCase - true or false

Method Detail

createConfigurationKeyName

public java.lang.String createConfigurationKeyName(java.lang.String configurationName,
                                                   java.lang.String keyName)

Description copied from interface: IEnumConfigurationKeyResolver

Create the configuration key name

Specified by:

createConfigurationKeyName in interface IEnumConfigurationKeyResolver

Parameters:

configurationName - the configuration name, e.g. the package and class name

keyName - the key name, e.g. the enumeration name

Returns:

the unique configuration key name

See Also:

IEnumConfigurationKeyResolver.createConfigurationKeyName(java.lang.String, java.lang.String)

resolveConfigurationKeyName

public <T extends java.lang.Enum<T>> java.lang.String resolveConfigurationKeyName(T configurationKey)

Description copied from interface: IEnumConfigurationKeyResolver

Resolves the configuration key name

Specified by:

resolveConfigurationKeyName in interface IEnumConfigurationKeyResolver

Type Parameters:

T - the generic type

Parameters:

configurationKey - the configuration key

Returns:

the configuration key name

See Also:

IEnumConfigurationKeyResolver.resolveConfigurationKeyName(java.lang.Enum)

resolveConfigurationKey

public <T extends java.lang.Enum<T>> T resolveConfigurationKey(java.lang.String configurationKeyName)

Description copied from interface: IEnumConfigurationKeyResolver

Resolves the configuration key

Specified by:

resolveConfigurationKey in interface IEnumConfigurationKeyResolver

Type Parameters:

T - the generic type

Parameters:

configurationKeyName - the configuration key name

Returns:

the configuration key

See Also:

IEnumConfigurationKeyResolver.resolveConfigurationKey(java.lang.String)

getEnumKeyValueConfiguration

public EnumKeyValueConfiguration getEnumKeyValueConfiguration(java.lang.String inputConfigurationKeyName)
                                                       throws EnumConfigurationStoreException

Description copied from interface: IEnumConfigurationKeyResolver

Get the enum key / value configuration information of an enum configuration name / key. It can be get either by interpreting of the annotation of the enum configuration or to load the previous generated JSON from internal / external source.

Specified by:

getEnumKeyValueConfiguration in interface IEnumConfigurationKeyResolver

Parameters:

inputConfigurationKeyName - the configuration key name

Returns:

the enum key value configuration

Throws:

EnumConfigurationStoreException - In case of an enum configuration store exception

See Also:

IEnumConfigurationKeyResolver.getEnumKeyValueConfiguration(java.lang.String)

clearCache

public void clearCache()

Clear cache

convertToConfigurationKey

protected <T extends java.lang.Enum<T>> T convertToConfigurationKey(java.lang.String configurationKeyName)

Convert the unique configuration key name into an enum configuration key type

Type Parameters:

T - the generic type

Parameters:

configurationKeyName - the configuration key name

Returns:

the configuration key type

convertToConfigurationKeyName

protected <T extends java.lang.Enum<T>> java.lang.String convertToConfigurationKeyName(T configurationKey)

Convert configuration key type into a unique configuration key name

Type Parameters:

T - the generic type

Parameters:

configurationKey - the configuration key

Returns:

the configuration key name

splitKeyName

protected java.lang.String[] splitKeyName(java.lang.String inputConfigurationKeyName)

Split the key name

Parameters:

inputConfigurationKeyName - the configuration key name

Returns:

the split

getConfigurationKeySeparator

protected java.lang.String getConfigurationKeySeparator()

Get the configuration key separator

Returns:

the configuration key separator