de.cismet.ext

Class CExtContext

java.lang.Object

de.cismet.ext.CExtContext

public class CExtContext
extends Object

Context that can be used to request extensions from the CExtManager. Users of extensions are asked to provide specific information how and for which purpose they intend to use the requested extension. Implementers of CExtProvider may in turn decide on basis of the given context object which implementation to provide or whether to provide an implementation at all. This context is backed by a HashMap. Thus the behavior of the operations of this class are the same as their HashMap equivalents (if applicable).

Version:

1.0, 2012/08/28

Author:

thorsten, mscholl

See Also:

CExtManager, CExtProvider, HashMap

Field Summary

Fields

Modifier and Type	Field and Description
static String	CTX_REFERENCE Constant that shall be used as key to put a reference object.

Constructor Summary

Constructors

Constructor and Description
CExtContext() Creates a new CExtContext object.
CExtContext(String key, Object value) Creates a new CExtContext object and put the given object in the property map.

Method Summary

Modifier and Type	Method and Description
Object	clearProperty(String key) Removes the value for the specified key from this map.
Object	getProperty(String key) Get the associated value for the specified key.
Map<String,Object>	getPropertyBag() Return the whole backing map implementation.
Object	putProperty(String key, Object value) Appends the specified key with the specified mapping value to the propertyBag.

Methods inherited from class java.lang.Object

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

Field Detail

CTX_REFERENCE

public static final String CTX_REFERENCE

Constant that shall be used as key to put a reference object. This object shall be a concrete instance for which the extension is requested.

See Also:

Constant Field Values

Constructor Detail

CExtContext

public CExtContext()

Creates a new CExtContext object.

CExtContext

public CExtContext(String key,
                   Object value)

Creates a new CExtContext object and put the given object in the property map.

Parameters:

key - the key for the given value

value - the value for the given key

Method Detail

putProperty

public Object putProperty(String key,
                          Object value)

Appends the specified key with the specified mapping value to the propertyBag. If the specified key already has an associated value, this value would get removed by the specified value

Parameters:

key - the key for the given value

value - the value for the given key

Returns:

the previous value associated with key, or null if there was no mapping for the specified key.

See Also:

Map.put(java.lang.Object, java.lang.Object)

getProperty

public Object getProperty(String key)

Get the associated value for the specified key.

Parameters:

key - the key, whose mapping is searched

Returns:

the value for the specified key, or null if there was no mapping for the specified key.

See Also:

Map.get(java.lang.Object)

getPropertyBag

public Map<String,Object> getPropertyBag()

Return the whole backing map implementation.

Returns:

the backing map implementation.

clearProperty

public Object clearProperty(String key)

Removes the value for the specified key from this map.

Parameters:

key - the key, whose mapping is removed

Returns:

the value, which is removed

See Also:

Map.remove(java.lang.Object)