org.codehaus.griffon.runtime.core

Class AbstractContext

java.lang.Object

org.codehaus.griffon.runtime.core.AbstractContext

All Implemented Interfaces:

Context

Direct Known Subclasses:

DefaultContext

public abstract class AbstractContext
extends java.lang.Object
implements Context

Since:

2.2.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	parentContext

Constructor Summary

Constructors

Constructor and Description
AbstractContext(Context parentContext)

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Searches for the key in this context and its hierarchy.
protected <T> T	convertValue(java.lang.Object value, java.lang.Class<T> type)
void	destroy() Destroys this context.
protected abstract java.lang.Object	doGet(java.lang.String key)
java.lang.Object	get(java.lang.String key) Returns the value associated with the given key.
<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, T defaultValue) Finds a value associated with the given key.
Context	getParentContext() Returns the parent Context if it exists.
<T> T	injectMembers(T instance) Inject properties and members annotated with griffon.inject.Contextual.

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.core.Context

hasKey, keySet, put, putAt, remove, removeAs, removeConverted

Field Detail

parentContext

protected Context parentContext

Constructor Detail

AbstractContext

public AbstractContext(@Nullable
                       Context parentContext)

Method Detail

getParentContext

@Nullable
public Context getParentContext()

Description copied from interface: Context

Returns the parent Context if it exists.

Specified by:

getParentContext in interface Context

get

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

Description copied from interface: Context

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a key.

Specified by:

get in interface Context

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: Context

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a key. Convenience method to use in Groovy aware environments.

Specified by:

getAt in interface Context

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: Context

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a key.

Specified by:

getAt in interface Context

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

get

@Nullable
public java.lang.Object get(@Nonnull
                                      java.lang.String key)

Description copied from interface: Context

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a key.

Specified by:

get in interface Context

Parameters:

key - the key to search

Returns:

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

destroy

public void destroy()

Description copied from interface: Context

Destroys this context. Once destroyed a context should not be used anymore.

Specified by:

destroy in interface Context

containsKey

public boolean containsKey(@Nonnull
                           java.lang.String key)

Description copied from interface: Context

Searches for the key in this context and its hierarchy.

Specified by:

containsKey in interface Context

Parameters:

key - the key to search

Returns:

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

doGet

@Nullable
protected abstract java.lang.Object doGet(@Nonnull
                                                    java.lang.String key)

getAsBoolean

public boolean getAsBoolean(@Nonnull
                            java.lang.String key)

Description copied from interface: Context

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

Specified by:

getAsBoolean in interface Context

Parameters:

key - the key to search

getAsBoolean

public boolean getAsBoolean(@Nonnull
                            java.lang.String key,
                            boolean defaultValue)

Description copied from interface: Context

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 Context

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: Context

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

Specified by:

getAsInt in interface Context

Parameters:

key - the key to search

getAsInt

public int getAsInt(@Nonnull
                    java.lang.String key,
                    int defaultValue)

Description copied from interface: Context

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 Context

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: Context

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

Specified by:

getAsLong in interface Context

Parameters:

key - the key to search

getAsLong

public long getAsLong(@Nonnull
                      java.lang.String key,
                      long defaultValue)

Description copied from interface: Context

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 Context

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: Context

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

Specified by:

getAsFloat in interface Context

Parameters:

key - the key to search

getAsFloat

public float getAsFloat(@Nonnull
                        java.lang.String key,
                        float defaultValue)

Description copied from interface: Context

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 Context

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: Context

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

Specified by:

getAsDouble in interface Context

Parameters:

key - the key to search

getAsDouble

public double getAsDouble(@Nonnull
                          java.lang.String key,
                          double defaultValue)

Description copied from interface: Context

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 Context

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: Context

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

Specified by:

getAsString in interface Context

Parameters:

key - the key to search

getAsString

@Nullable
public java.lang.String getAsString(@Nonnull
                                              java.lang.String key,
                                              @Nullable
                                              java.lang.String defaultValue)

Description copied from interface: Context

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 Context

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
                             java.lang.String key)

Description copied from interface: Context

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

Specified by:

getAs in interface Context

Parameters:

key - the key to search

getAs

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

Description copied from interface: Context

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 Context

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: Context

/** 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 Context

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: Context

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 Context

Parameters:

key - the key to search

type - the type to be returned

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)

injectMembers

@Nonnull
public <T> T injectMembers(@Nonnull
                                    T instance)

Description copied from interface: Context

Inject properties and members annotated with griffon.inject.Contextual.

Specified by:

injectMembers in interface Context

Type Parameters:

T - the type of the instance

Parameters:

instance - the instance on which contextual members will be injected.

Returns:

the instance on which contextual members where injected.