griffon.core

Interface Configuration

All Known Subinterfaces:

MutableConfiguration

All Known Implementing Classes:

AbstractConfiguration, AbstractMapConfiguration, ConfigurationDecorator, DefaultConfiguration, DelegatingMutableConfiguration, ResourceBundleConfiguration

public interface Configuration

Since:

2.0.0

Author:

Andres Almiray

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.
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, String format) Finds a value associated with the given key.
<T> T	getConverted(String key, Class<T> type, String format, T defaultValue) 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.

Method Detail

containsKey

boolean containsKey(@Nonnull
                    String key)

Searches for the key in this configuration.

Parameters:

key - the key to search

Returns:

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

asFlatMap

@Nonnull
Map<String,Object> asFlatMap()

asResourceBundle

@Nonnull
ResourceBundle asResourceBundle()

asProperties

@Nonnull
Properties asProperties()

get

@Nullable
Object get(@Nonnull
                     String key)

Returns the value associated with the given key.

Parameters:

key - the key to search

Returns:

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

get

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

Returns the value associated with the given key.

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
Object getAt(@Nonnull
                       String key)

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

Parameters:

key - the key to search

Returns:

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

getAt

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

Returns the value associated with the given key.

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

boolean getAsBoolean(@Nonnull
                     String key)

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

Parameters:

key - the key to search

getAsBoolean

boolean getAsBoolean(@Nonnull
                     String key,
                     boolean defaultValue)

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.

Parameters:

key - the key to search

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

getAsInt

int getAsInt(@Nonnull
             String key)

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

Parameters:

key - the key to search

getAsInt

int getAsInt(@Nonnull
             String key,
             int defaultValue)

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.

Parameters:

key - the key to search

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

getAsLong

long getAsLong(@Nonnull
               String key)

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

Parameters:

key - the key to search

getAsLong

long getAsLong(@Nonnull
               String key,
               long defaultValue)

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.

Parameters:

key - the key to search

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

getAsFloat

float getAsFloat(@Nonnull
                 String key)

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

Parameters:

key - the key to search

getAsFloat

float getAsFloat(@Nonnull
                 String key,
                 float defaultValue)

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.

Parameters:

key - the key to search

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

getAsDouble

double getAsDouble(@Nonnull
                   String key)

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

Parameters:

key - the key to search

getAsDouble

double getAsDouble(@Nonnull
                   String key,
                   double defaultValue)

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.

Parameters:

key - the key to search

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

getAsString

@Nullable
String getAsString(@Nonnull
                             String key)

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

Parameters:

key - the key to search

getAsString

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

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.

Parameters:

key - the key to search

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

getAs

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

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

Parameters:

key - the key to search

Since:

2.5.0

getAs

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

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.

Parameters:

key - the key to search

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

Since:

2.5.0

getConverted

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

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

Parameters:

key - the key to search

type - the type to be returned

Since:

2.5.0

getConverted

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

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

Parameters:

key - the key to search

type - the type to be returned

format - format used to convert the value

Since:

2.11.0

getConverted

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

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.

Parameters:

key - the key to search

type - the type to be returned

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

Since:

2.5.0

getConverted

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

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.

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

Since:

2.11.0