org.codehaus.griffon.runtime.core

Class DefaultContext

java.lang.Object

org.codehaus.griffon.runtime.core.AbstractContext

org.codehaus.griffon.runtime.core.DefaultContext

All Implemented Interfaces:

Context

Direct Known Subclasses:

DefaultObservableContext

public class DefaultContext
extends AbstractContext

Since:

2.2.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ERROR_KEY_BLANK

Fields inherited from class org.codehaus.griffon.runtime.core.AbstractContext

parentContext

Constructor Summary

Constructors

Constructor and Description
DefaultContext()
DefaultContext(Context parentContext)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this context.
protected java.lang.Object	doGet(java.lang.String key)
boolean	hasKey(java.lang.String key) Searches for the key in this context only.
java.util.Set<java.lang.String>	keySet() Returns a Set view of the keys contained in this context.
void	put(java.lang.String key, java.lang.Object value) Sets a key/value pair on this context.
void	putAt(java.lang.String key, java.lang.Object value) Sets a key/value pair on this context.
java.lang.Object	remove(java.lang.String key) Removes a key from this context.
<T> T	removeAs(java.lang.String key) Removes a key from this context.
<T> T	removeConverted(java.lang.String key, java.lang.Class<T> type) Removes a key from this context.

Methods inherited from class org.codehaus.griffon.runtime.core.AbstractContext

containsKey, convertValue, get, get, getAs, getAs, getAsBoolean, getAsBoolean, getAsDouble, getAsDouble, getAsFloat, getAsFloat, getAsInt, getAsInt, getAsLong, getAsLong, getAsString, getAsString, getAt, getAt, getConverted, getConverted, getParentContext, injectMembers

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_KEY_BLANK

protected static final java.lang.String ERROR_KEY_BLANK

See Also:

Constant Field Values

Constructor Detail

DefaultContext

public DefaultContext()

DefaultContext

public DefaultContext(@Nullable
                      Context parentContext)

Method Detail

doGet

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

Specified by:

doGet in class AbstractContext

hasKey

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

Description copied from interface: Context

Searches for the key in this context only.

Parameters:

key - the key to search

Returns:

true if the context contains the given key, false otherwise

remove

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

Description copied from interface: Context

Removes a key from this context. Does not affect the context's hierarchy.

Parameters:

key - the key to be removed

Returns:

the value associated with the key or null if there wasn't any value.

removeAs

@Nullable
public <T> T removeAs(@Nonnull
                                java.lang.String key)

Description copied from interface: Context

Removes a key from this context. Does not affect the context's hierarchy. Blindly casts the returned value.

Parameters:

key - the key to be removed

Returns:

the value associated with the key or null if there wasn't any value.

removeConverted

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

Description copied from interface: Context

Removes a key from this context. Does not affect the context's hierarchy. The value is converted to type T if found using a PropertyEditor.

Parameters:

key - the key to be removed

type - the type to be returned

Returns:

the value associated with the key or null if there wasn't any value.

put

public void put(@Nonnull
                java.lang.String key,
                @Nullable
                java.lang.Object value)

Description copied from interface: Context

Sets a key/value pair on this context. If the context has a parent and if the key matches a parent key then the value will shadow the parent's, that is, the parent value will not be overwritten.

Parameters:

key - the key to be registered

value - the value to save

putAt

public void putAt(@Nonnull
                  java.lang.String key,
                  @Nullable
                  java.lang.Object value)

Description copied from interface: Context

Sets a key/value pair on this context. If the context has a parent and if the key matches a parent key then the value will shadow the parent's, that is, the parent value will not be overwritten. Convenience method to use in Groovy aware environments.

Parameters:

key - the key to be registered

value - the value to save

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

Overrides:

destroy in class AbstractContext

keySet

@Nonnull
public java.util.Set<java.lang.String> keySet()

Description copied from interface: Context

Returns a Set view of the keys contained in this context.

Returns:

a set view of the keys contained in this map