org.codehaus.griffon.runtime.core.configuration

Class AbstractConfiguration

java.lang.Object

org.codehaus.griffon.runtime.core.configuration.AbstractConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

AbstractMapConfiguration, ResourceBundleConfiguration

public abstract class AbstractConfiguration
extends java.lang.Object
implements Configuration

Since:

2.0.0

Author:

Andres Almiray

Constructor Summary

Constructors

Constructor and Description
AbstractConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.Properties	asProperties()
protected <T> T	convertValue(java.lang.Object value, java.lang.Class<T> type)
protected <T> T	convertValue(java.lang.Object value, java.lang.Class<T> type, java.lang.String format)
<T> T	get(java.lang.String key, T defaultValue) Returns the value associated with the given key.
<T> T	getAs(java.lang.String key) /** Finds a value associated with the given key.
<T> T	getAs(java.lang.String key, T defaultValue) Finds a value associated with the given key.
boolean	getAsBoolean(java.lang.String key) Finds a value associated with the given key.
boolean	getAsBoolean(java.lang.String key, boolean defaultValue) Finds a value associated with the given key.
double	getAsDouble(java.lang.String key) Finds a value associated with the given key.
double	getAsDouble(java.lang.String key, double defaultValue) Finds a value associated with the given key.
float	getAsFloat(java.lang.String key) Finds a value associated with the given key.
float	getAsFloat(java.lang.String key, float defaultValue) Finds a value associated with the given key.
int	getAsInt(java.lang.String key) Finds a value associated with the given key.
int	getAsInt(java.lang.String key, int defaultValue) Finds a value associated with the given key.
long	getAsLong(java.lang.String key) Finds a value associated with the given key.
long	getAsLong(java.lang.String key, long defaultValue) Finds a value associated with the given key.
java.lang.String	getAsString(java.lang.String key) Finds a value associated with the given key.
java.lang.String	getAsString(java.lang.String key, java.lang.String defaultValue) Finds a value associated with the given key.
java.lang.Object	getAt(java.lang.String key) Returns the value associated with the given key.
<T> T	getAt(java.lang.String key, T defaultValue) Returns the value associated with the given key.
<T> T	getConverted(java.lang.String key, java.lang.Class<T> type) Finds a value associated with the given key.
<T> T	getConverted(java.lang.String key, java.lang.Class<T> type, java.lang.String format) Finds a value associated with the given key.
<T> T	getConverted(java.lang.String key, java.lang.Class<T> type, java.lang.String format, T defaultValue) Finds a value associated with the given key.
<T> T	getConverted(java.lang.String key, java.lang.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

Methods inherited from interface griffon.core.Configuration

asFlatMap, asResourceBundle, containsKey, get

Constructor Detail

AbstractConfiguration

public AbstractConfiguration()

Method Detail

get

@Nullable
public <T> T get(@Nonnull
                           java.lang.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 java.lang.Object getAt(@Nonnull
                                        java.lang.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
                             java.lang.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
                            java.lang.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
                            java.lang.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
                    java.lang.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
                    java.lang.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
                      java.lang.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
                      java.lang.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
                        java.lang.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
                        java.lang.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
                          java.lang.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
                          java.lang.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 java.lang.String getAsString(@Nonnull
                                              java.lang.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

getAs

@Nullable
public <T> T getAs(@Nonnull
                             java.lang.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
                             java.lang.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
                                    java.lang.String key,
                                    @Nonnull
                                    java.lang.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
                                    java.lang.String key,
                                    @Nonnull
                                    java.lang.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

getConverted

@Nullable
public <T> T getConverted(@Nonnull
                                    java.lang.String key,
                                    @Nonnull
                                    java.lang.Class<T> type,
                                    @Nonnull
                                    java.lang.String format)

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

format - format used to convert the value

getConverted

@Nullable
public <T> T getConverted(@Nonnull
                                    java.lang.String key,
                                    @Nonnull
                                    java.lang.Class<T> type,
                                    @Nonnull
                                    java.lang.String format,
                                    @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

format - format used to convert the value

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

convertValue

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

convertValue

protected <T> T convertValue(@Nullable
                             java.lang.Object value,
                             @Nonnull
                             java.lang.Class<T> type,
                             @Nonnull
                             java.lang.String format)

getAsString

@Nullable
public java.lang.String getAsString(@Nonnull
                                              java.lang.String key,
                                              @Nullable
                                              java.lang.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

asProperties

@Nonnull
public java.util.Properties asProperties()

Specified by:

asProperties in interface Configuration