| java.util.HashMap
 org.apache.commons.chain.impl.ContextBase
All known Subclasses: org.apache.commons.chain.web.WebContext, org.apache.commons.chain.impl.TestContext,
| ContextBase | | public class ContextBase extends HashMap implements Context(Code) | | Convenience base class for
Context implementations.
In addition to the minimal functionality required by the
Context interface, this class implements the recommended support for
Attribute-Property Transparency . This is implemented by
analyzing the available JavaBeans properties of this class (or its
subclass), exposes them as key-value pairs in the Map,
with the key being the name of the property itself.
IMPLEMENTATION NOTE - Because empty is a
read-only property defined by the Map interface, it may not
be utilized as an attribute key or property name.
author:
Craig R. McClanahan
version:
$Revision: 412150 $ $Date: 2006-06-06 16:31:50 +0100 (Tue, 06 Jun 2006) $ |
| Constructor Summary | |
| public | ContextBase()
Default, no argument constructor. | | public | ContextBase(Map map)
Initialize the contents of this
Context by copying the
values from the specified Map. |
| Method Summary | |
| public void | clear()
| | public boolean | containsValue(Object value)
Override the default Map behavior to return
true if the specified value is present in either the
underlying Map or one of the local property values.
Parameters:
value - the value look for in the context. | | public Set | entrySet()
| | public Object | get(Object key)
Override the default Map behavior to return the value
of a local property if the specified key matches a local property name. | | public boolean | isEmpty()
| | public Set | keySet()
| | public Object | put(Object key, Object value)
Override the default Map behavior to set the value
of a local property if the specified key matches a local property name. | | public void | putAll(Map map)
| | public Object | remove(Object key)
| | public Collection | values()
|
| ContextBase | | public ContextBase()(Code) | | Default, no argument constructor.
|
| ContextBase | | public ContextBase(Map map)(Code) | | Initialize the contents of this
Context by copying the
values from the specified Map. Any keys in map
that correspond to local properties will cause the setter method for
that property to be called.
Parameters:
map - Map whose key-value pairs are added
exception:
IllegalArgumentException - if an exception is thrownwriting a local property value
exception:
UnsupportedOperationException - if a local property does nothave a write method. |
| clear | | public void clear()(Code) | | Override the default Map behavior to clear all keys and
values except those corresponding to JavaBeans properties.
|
| containsValue | | public boolean containsValue(Object value)(Code) | | Override the default Map behavior to return
true if the specified value is present in either the
underlying Map or one of the local property values.
Parameters:
value - the value look for in the context. true if found in this context otherwisefalse.
exception:
IllegalArgumentException - if a property getterthrows an exception |
| entrySet | | public Set entrySet()(Code) | | Override the default Map behavior to return a
Set that meets the specified default behavior except
for attempts to remove the key for a property of the
Context implementation class, which will throw
UnsupportedOperationException.
Set of entries in the Context. |
| get | | public Object get(Object key)(Code) | | Override the default Map behavior to return the value
of a local property if the specified key matches a local property name.
IMPLEMENTATION NOTE - If the specified
key identifies a write-only property, null
will arbitrarily be returned, in order to avoid difficulties implementing
the contracts of the Map interface.
Parameters:
key - Key of the value to be returned The value for the specified key.
exception:
IllegalArgumentException - if an exception is thrownreading this local property value
exception:
UnsupportedOperationException - if this local property does nothave a read method. |
| isEmpty | | public boolean isEmpty()(Code) | | Override the default Map behavior to return
true if the underlying Map only contains
key-value pairs for local properties (if any).
true if this Context is empty, otherwisefalse. |
| keySet | | public Set keySet()(Code) | | Override the default Map behavior to return a
Set that meets the specified default behavior except
for attempts to remove the key for a property of the
Context implementation class, which will throw
UnsupportedOperationException.
The set of keys for objects in this Context. |
| put | | public Object put(Object key, Object value)(Code) | | Override the default Map behavior to set the value
of a local property if the specified key matches a local property name.
Parameters:
key - Key of the value to be stored or replaced
Parameters:
value - New value to be stored The value added to the Context.
exception:
IllegalArgumentException - if an exception is thrownreading or wrting this local property value
exception:
UnsupportedOperationException - if this local property does nothave both a read method and a write method |
| putAll | | public void putAll(Map map)(Code) | | Override the default Map behavior to call the
put() method individually for each key-value pair
in the specified Map.
Parameters:
map - Map containing key-value pairs to store(or replace)
exception:
IllegalArgumentException - if an exception is thrownreading or wrting a local property value
exception:
UnsupportedOperationException - if a local property does nothave both a read method and a write method |
| remove | | public Object remove(Object key)(Code) | | Override the default Map behavior to throw
UnsupportedOperationException on any attempt to
remove a key that is the name of a local property.
Parameters:
key - Key to be removed The value removed from the Context.
exception:
UnsupportedOperationException - if the specifiedkey matches the name of a local property |
| values | | public Collection values()(Code) | | Override the default Map behavior to return a
Collection that meets the specified default behavior except
for attempts to remove the key for a property of the
Context implementation class, which will throw
UnsupportedOperationException.
The collection of values in this Context. |
|
|