org.codehaus.groovy.grails.commons.cfg

Class GrailsConfig

java.lang.Object

org.codehaus.groovy.grails.commons.cfg.GrailsConfig

public class GrailsConfig
extends java.lang.Object

Type safe abstraction over Grails configuration

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SPRING_PLACEHOLDER_PREFIX

Constructor Summary

Constructors

Constructor and Description
GrailsConfig(GrailsApplication grailsApplication)

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String key) Utility method for retrieving a configuration value.
<T> T	get(java.lang.String key, java.lang.Class<T> type) Utility method for retrieving a configuration value and performs type checking (i.e.
<T> T	get(java.lang.String key, T defaultValue) Configuration Value lookup with a default value.
<T> T	get(java.lang.String key, T defaultValue, java.util.List<T> allowedValues) Configuration Value lookup with a default value and a list of allowed values.
java.lang.Object	getAt(java.lang.Object key) Configuration Value lookup for Groovy's array-like property access GrailsConfig['my.config.key']
groovy.util.ConfigObject	getConfig()
java.util.Map	getFlatConfig()
<T> T	getMandatory(java.lang.String key) Configuration Value lookup with thows a GrailsConfigurationException when the value is null
<T> T	getMandatory(java.lang.String key, java.util.List<T> allowedValues) Configuration Value lookup with thows a GrailsConfigurationException when the value is null or not within the allowedValues.

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_PLACEHOLDER_PREFIX

public static final java.lang.String SPRING_PLACEHOLDER_PREFIX

See Also:

Constant Field Values

Constructor Detail

GrailsConfig

public GrailsConfig(GrailsApplication grailsApplication)

Method Detail

get

public <T> T get(java.lang.String key)

Utility method for retrieving a configuration value.

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

Returns:

the value retrieved by ConfigurationHolder.flatConfig

get

public <T> T get(java.lang.String key,
                 java.lang.Class<T> type)

Utility method for retrieving a configuration value and performs type checking (i.e. logs a verbose WARN message on type mismatch).

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

type - the required type

Returns:

the value retrieved by ConfigurationHolder.flatConfig

get

public <T> T get(java.lang.String key,
                 T defaultValue)

Configuration Value lookup with a default value.

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

defaultValue - the default value

Returns:

the value retrieved by ConfigurationHolder.flatConfig if not null, otherwise the defaultValue

get

public <T> T get(java.lang.String key,
                 T defaultValue,
                 java.util.List<T> allowedValues)

Configuration Value lookup with a default value and a list of allowed values.

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

defaultValue - the default value

allowedValues - List of allowed values

Returns:

the value retrieved by ConfigurationHolder.flatConfig, if it is contained in allowedValues, otherwise the defaultValue

getMandatory

public <T> T getMandatory(java.lang.String key)

Configuration Value lookup with thows a GrailsConfigurationException when the value is null

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

Returns:

the value retrieved by ConfigurationHolder.flatConfig

getMandatory

public <T> T getMandatory(java.lang.String key,
                          java.util.List<T> allowedValues)

Configuration Value lookup with thows a GrailsConfigurationException when the value is null or not within the allowedValues.

Type Parameters:

T - the type parameter

Parameters:

key - the flattened key

allowedValues - List of allowed values

Returns:

the value retrieved by ConfigurationHolder.flatConfig

getAt

public java.lang.Object getAt(java.lang.Object key)

Configuration Value lookup for Groovy's array-like property access GrailsConfig['my.config.key']

Parameters:

key - the config key

Returns:

the configured value

getFlatConfig

public java.util.Map getFlatConfig()

getConfig

public groovy.util.ConfigObject getConfig()