griffon.core

Interface Context

All Known Subinterfaces:

ObservableContext

All Known Implementing Classes:

AbstractContext, DefaultContext, DefaultObservableContext

public interface Context

Since:

2.2.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Searches for the key in this context and its hierarchy.
void	destroy() Destroys this context.
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.
boolean	hasKey(java.lang.String key) Searches for the key in this context only.
<T> T	injectMembers(T instance) Inject properties and members annotated with griffon.inject.Contextual.
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.

Method Detail

containsKey

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

Searches for the key in this context and its hierarchy.

Parameters:

key - the key to search

Returns:

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

Since:

2.4.0

hasKey

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

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
java.lang.Object remove(@Nonnull
                                  java.lang.String key)

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
<T> T removeAs(@Nonnull
                         java.lang.String key)

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.

Since:

2.5.0

removeConverted

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

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.

Since:

2.5.0

put

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

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

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

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

get

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

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a 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
                    java.lang.String key,
                    @Nullable
                    T defaultValue)

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a 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
java.lang.Object getAt(@Nonnull
                                 java.lang.String key)

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.

Parameters:

key - the key to search

Returns:

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

getAt

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

Returns the value associated with the given key. This operation will traverse up the context hierarchy until it finds a 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

destroy

void destroy()

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

getParentContext

@Nullable
Context getParentContext()

Returns the parent Context if it exists.

Since:

2.4.0

keySet

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

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

Returns:

a set view of the keys contained in this map

Since:

2.4.0

getAsBoolean

boolean getAsBoolean(@Nonnull
                     java.lang.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

Since:

2.5.0

getAsBoolean

boolean getAsBoolean(@Nonnull
                     java.lang.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

Since:

2.5.0

getAsInt

int getAsInt(@Nonnull
             java.lang.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

Since:

2.5.0

getAsInt

int getAsInt(@Nonnull
             java.lang.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

Since:

2.5.0

getAsLong

long getAsLong(@Nonnull
               java.lang.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

Since:

2.5.0

getAsLong

long getAsLong(@Nonnull
               java.lang.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

Since:

2.5.0

getAsFloat

float getAsFloat(@Nonnull
                 java.lang.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

Since:

2.5.0

getAsFloat

float getAsFloat(@Nonnull
                 java.lang.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

Since:

2.5.0

getAsDouble

double getAsDouble(@Nonnull
                   java.lang.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

Since:

2.5.0

getAsDouble

double getAsDouble(@Nonnull
                   java.lang.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

Since:

2.5.0

getAsString

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

Since:

2.5.0

getAsString

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

Since:

2.5.0

getAs

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

injectMembers

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

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

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.