org.codehaus.griffon.runtime.core

Class ConfigurationDecorator

java.lang.Object

org.codehaus.griffon.runtime.core.ConfigurationDecorator

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

DelegatingMutableConfiguration

public class ConfigurationDecorator
extends Object
implements Configuration

Since:

2.2.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	delegate

Constructor Summary

Constructors

Constructor and Description
ConfigurationDecorator(Configuration delegate)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asFlatMap()
Properties	asProperties()
ResourceBundle	asResourceBundle()
boolean	containsKey(String key) Searches for the key in this configuration.
protected <T> T	convertValue(Object value, Class<T> type)
Object	get(String key) Returns the value associated with the given key.
<T> T	get(String key, T defaultValue) Returns the value associated with the given key.
<T> T	getAs(String key) /** Finds a value associated with the given key.
<T> T	getAs(String key, T defaultValue) Finds a value associated with the given key.
boolean	getAsBoolean(String key) Finds a value associated with the given key.
boolean	getAsBoolean(String key, boolean defaultValue) Finds a value associated with the given key.
double	getAsDouble(String key) Finds a value associated with the given key.
double	getAsDouble(String key, double defaultValue) Finds a value associated with the given key.
float	getAsFloat(String key) Finds a value associated with the given key.
float	getAsFloat(String key, float defaultValue) Finds a value associated with the given key.
int	getAsInt(String key) Finds a value associated with the given key.
int	getAsInt(String key, int defaultValue) Finds a value associated with the given key.
long	getAsLong(String key) Finds a value associated with the given key.
long	getAsLong(String key, long defaultValue) Finds a value associated with the given key.
String	getAsString(String key) Finds a value associated with the given key.
String	getAsString(String key, String defaultValue) Finds a value associated with the given key.
Object	getAt(String key) Returns the value associated with the given key.
<T> T	getAt(String key, T defaultValue) Returns the value associated with the given key.
<T> T	getConverted(String key, Class<T> type) Finds a value associated with the given key.
<T> T	getConverted(String key, Class<T> type, T defaultValue) Finds a value associated with the given key.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final Configuration delegate

Constructor Detail

ConfigurationDecorator

public ConfigurationDecorator(@Nonnull
                              Configuration delegate)

Method Detail

get

@Nullable
public Object get(@Nonnull
                            String key)

Description copied from interface: Configuration

Returns the value associated with the given key.

Specified by:

get in interface Configuration

Parameters:

key - the key to search

Returns:

the value associated with the key or null< if not found.

get

@Nullable
public <T> T get(@Nonnull
                           String key,
                           @Nullable
                           T defaultValue)

Description copied from interface: Configuration

Returns the value associated with the given key.

Specified by:

get in interface Configuration

Type Parameters:

T - the type of the value

Parameters:

key - the key to search

defaultValue - the value to be returned if the key was not found

Returns:

returns the value associated with the key, defaultValue if the key was not found

getAt

@Nullable
public Object getAt(@Nonnull
                              String key)

Description copied from interface: Configuration

Returns the value associated with the given key. Convenience method to use in Groovy aware environments.

Specified by:

getAt in interface Configuration

Parameters:

key - the key to search

Returns:

the value associated with the key or null< if not found.

getAt

@Nullable
public <T> T getAt(@Nonnull
                             String key,
                             @Nullable
                             T defaultValue)

Description copied from interface: Configuration

Returns the value associated with the given key.

Specified by:

getAt in interface Configuration

Type Parameters:

T - the type of the value

Parameters:

key - the key to search

defaultValue - the value to be returned if the key was not found

Returns:

returns the value associated with the key, defaultValue if the key was not found

getAsBoolean

public boolean getAsBoolean(@Nonnull
                            String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a boolean if found.

Specified by:

getAsBoolean in interface Configuration

Parameters:

key - the key to search

getAsBoolean

public boolean getAsBoolean(@Nonnull
                            String key,
                            boolean defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a boolean if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsBoolean in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAsInt

public int getAsInt(@Nonnull
                    String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to an int if found.

Specified by:

getAsInt in interface Configuration

Parameters:

key - the key to search

getAsInt

public int getAsInt(@Nonnull
                    String key,
                    int defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to an int if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsInt in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAsLong

public long getAsLong(@Nonnull
                      String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a long if found.

Specified by:

getAsLong in interface Configuration

Parameters:

key - the key to search

getAsLong

public long getAsLong(@Nonnull
                      String key,
                      long defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a long if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsLong in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAsFloat

public float getAsFloat(@Nonnull
                        String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a float if found.

Specified by:

getAsFloat in interface Configuration

Parameters:

key - the key to search

getAsFloat

public float getAsFloat(@Nonnull
                        String key,
                        float defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a float if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsFloat in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAsDouble

public double getAsDouble(@Nonnull
                          String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a double if found.

Specified by:

getAsDouble in interface Configuration

Parameters:

key - the key to search

getAsDouble

public double getAsDouble(@Nonnull
                          String key,
                          double defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a double if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsDouble in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAsString

@Nullable
public String getAsString(@Nonnull
                                    String key)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a String if found.

Specified by:

getAsString in interface Configuration

Parameters:

key - the key to search

getAsString

@Nullable
public String getAsString(@Nonnull
                                    String key,
                                    @Nullable
                                    String defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to a String if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAsString in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getAs

@Nullable
public <T> T getAs(@Nonnull
                             String key)

Description copied from interface: Configuration

/** Finds a value associated with the given key. The value is blindly cast to type T if found.

Specified by:

getAs in interface Configuration

Parameters:

key - the key to search

getAs

@Nullable
public <T> T getAs(@Nonnull
                             String key,
                             @Nullable
                             T defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is blindly cast to type T if found. If not found then the supplied defaultValue will be returned.

Specified by:

getAs in interface Configuration

Parameters:

key - the key to search

defaultValue - the value to be returned if the key is not found

getConverted

@Nullable
public <T> T getConverted(@Nonnull
                                    String key,
                                    @Nonnull
                                    Class<T> type)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to type T if found using a PropertyEditor.

Specified by:

getConverted in interface Configuration

Parameters:

key - the key to search

type - the type to be returned

getConverted

@Nullable
public <T> T getConverted(@Nonnull
                                    String key,
                                    @Nonnull
                                    Class<T> type,
                                    @Nullable
                                    T defaultValue)

Description copied from interface: Configuration

Finds a value associated with the given key. The value is converted to type T if found using a PropertyEditor. If not found then the supplied defaultValue will be returned.

Specified by:

getConverted in interface Configuration

Parameters:

key - the key to search

type - the type to be returned

defaultValue - the value to be returned if the key is not found

asProperties

@Nonnull
public Properties asProperties()

Specified by:

asProperties in interface Configuration

containsKey

public boolean containsKey(@Nonnull
                           String key)

Description copied from interface: Configuration

Searches for the key in this configuration.

Specified by:

containsKey in interface Configuration

Parameters:

key - the key to search

Returns:

true if the context (or its parent) contains the given key, false otherwise

asFlatMap

@Nonnull
public Map<String,Object> asFlatMap()

Specified by:

asFlatMap in interface Configuration

asResourceBundle

@Nonnull
public ResourceBundle asResourceBundle()

Specified by:

asResourceBundle in interface Configuration

convertValue

protected <T> T convertValue(@Nullable
                             Object value,
                             @Nonnull
                             Class<T> type)