| java.lang.Object
 bsh.engine.ScriptContextEngineView
| ScriptContextEngineView | | public class ScriptContextEngineView implements Map<String, Object>(Code) | | This class implements an ENGINE_SCOPE centric Map view of the ScriptContext
for engine implementations. This class can be used to simplify engine
implementations which have the capability to bind their namespaces to Maps
or other external interfaces.
Get operations on this view delegate to the
ScriptContext inheriting get() method that automatically traverses the
binding scopes in order or precedence. Put operations on this view always
store values in the ENGINE_SCOPE bindings. Other operations such as
size() and contains() are implemented appropriately, but perhaps not as
efficiently as possible.
|
| Method Summary | |
| public void | clear()
Removes all mappings from this map (optional operation). | | public boolean | containsKey(Object key)
Returns true if the key name is bound in any scope in the context.
The key must be a String.
Parameters:
key - key whose presence in this map is to be tested. | | public boolean | containsValue(Object value)
Returns true if this map maps one or more keys to the specified
value. | | public Set<Entry<String, Object>> | entrySet()
Returns a set view of the mappings contained in this map. | | public Object | get(Object key)
Returns the value bound in the most specific (lowest numbered)
bindings space for this key.
key must be a String.
Parameters:
key - key whose associated value is to be returned. | | public boolean | isEmpty()
Returns true if no bindings are present in any scope of the context. | | public Set | keySet()
Returns the total key set of all scopes. | | public Object | put(String key, Object value)
Set the key, value binding in the ENGINE_SCOPE of the context.
Parameters:
key - key with which the specified value is to be associated.
Parameters:
value - value to be associated with the specified key. | | public void | putAll(Map<? extends String, ? extends Object> t)
Put the bindings into the ENGINE_SCOPE of the context. | | public Object | remove(Object okey)
Removes the mapping from the engine scope.
Returns the value to which the map previously associated the key, or
null if the map contained no mapping for this key. | | public int | size()
Returns the number of unique object bindings in all scopes. | | public Collection | values()
Returns the total values set of all scopes. |
| containsKey | | public boolean containsKey(Object key)(Code) | | Returns true if the key name is bound in any scope in the context.
The key must be a String.
Parameters:
key - key whose presence in this map is to be tested. true if this map contains a mapping for the specified key.
throws:
ClassCastException - if the key is of an inappropriate type for thismap (optional).
throws:
NullPointerException - if the key is null and this map doesnot permit null keys (optional). |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if this map maps one or more keys to the specified
value. More formally, returns true if and only if this map
contains at least one mapping to a value v such that
(value==null ? v==null : value.equals(v)). This operation will
probably require time linear in the map size for most implementations of the
Map interface.
Parameters:
value - value whose presence in this map is to be tested. true if this map maps one or more keys to the specifiedvalue.
throws:
ClassCastException - if the value is of an inappropriate type for thismap (optional).
throws:
NullPointerException - if the value is null and this map doesnot permit null values (optional). |
| entrySet | | public Set<Entry<String, Object>> entrySet()(Code) | | Returns a set view of the mappings contained in this map. Each element in
the returned set is a
java.util.Map.Entry . The set is backed by the
map, so changes to the map are reflected in the set, and vice-versa. If the
map is modified while an iteration over the set is in progress (except
through the iterator's own remove operation, or through the
setValue operation on a map entry returned by the iterator) the
results of the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove, removeAll,
retainAll and clear operations. It does not support the
add or addAll operations.
a set view of the mappings contained in this map. |
| get | | public Object get(Object key)(Code) | | Returns the value bound in the most specific (lowest numbered)
bindings space for this key.
key must be a String.
Parameters:
key - key whose associated value is to be returned. the value to which this map maps the specified key, or nullif the map contains no mapping for this key.
throws:
ClassCastException - if the key is of an inappropriate type for thismap (optional).
throws:
NullPointerException - if the key is null and this map doesnot permit null keys (optional).
See Also: ScriptContextEngineView.containsKey(Object) |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if no bindings are present in any scope of the context.
|
| keySet | | public Set keySet()(Code) | | Returns the total key set of all scopes.
This method violates the Map contract by returning an unmodifiable set.
a set view of the keys contained in this map. |
| put | | public Object put(String key, Object value)(Code) | | Set the key, value binding in the ENGINE_SCOPE of the context.
Parameters:
key - key with which the specified value is to be associated.
Parameters:
value - value to be associated with the specified key. previous value associated with specified key, or null ifthere was no mapping for key. A null return can alsoindicate that the map previously associated null with thespecified key, if the implementation supports null values.
throws:
UnsupportedOperationException - if the put operation is notsupported by this map.
throws:
ClassCastException - if the class of the specified key or valueprevents it from being stored in this map.
throws:
IllegalArgumentException - if some aspect of this key or valueprevents it from being stored in this map.
throws:
NullPointerException - if this map does not permit null keysor values, and the specified key or value is null. |
| putAll | | public void putAll(Map<? extends String, ? extends Object> t)(Code) | | Put the bindings into the ENGINE_SCOPE of the context.
Parameters:
t - Mappings to be stored in this map.
throws:
UnsupportedOperationException - if the putAll method is notsupported by this map.
throws:
ClassCastException - if the class of a key or value in the specifiedmap prevents it from being stored in this map.
throws:
IllegalArgumentException - some aspect of a key or value in thespecified map prevents it from being stored in this map.
throws:
NullPointerException - if the specified map is null, or ifthis map does not permit null keys or values, and the specified mapcontains null keys or values. |
| remove | | public Object remove(Object okey)(Code) | | Removes the mapping from the engine scope.
Returns the value to which the map previously associated the key, or
null if the map contained no mapping for this key. (A
null return can also indicate that the map previously associated
null with the specified key if the implementation supports
null values.) The map will not contain a mapping for the specified
key once the call returns.
Parameters:
okey - key whose mapping is to be removed from the map. previous value associated with specified key, or null ifthere was no mapping for key.
throws:
ClassCastException - if the key is of an inappropriate type for thismap (optional).
throws:
NullPointerException - if the key is null and this map doesnot permit null keys (optional).
throws:
UnsupportedOperationException - if the remove method is notsupported by this map. |
| size | | public int size()(Code) | | Returns the number of unique object bindings in all scopes.
(duplicate, shadowed, bindings count as a single binging).
|
| values | | public Collection values()(Code) | | Returns the total values set of all scopes.
This method violates the Map contract by returning an unmodifiable set.
a collection view of the values contained in this map. |
|
|