FileDocCategorySizeDatePackage
SimpleBindings.javaAPI DocJava SE 6 API6921Tue Jun 10 00:26:26 BST 2008javax.script

SimpleBindings

public class SimpleBindings extends Object implements Bindings
A simple implementation of Bindings backed by a HashMap or some other specified Map.
author
Mike Grogan
version
1.0
since
1.6

Fields Summary
private Map
map
The Map field stores the attributes.
Constructors Summary
public SimpleBindings(Map m)
Constructor uses an existing Map to store the values.

param
m The Map backing this SimpleBindings.
throws
NullPointerException if m is null

        if (m == null) {
            throw new NullPointerException();
        }
        this.map = m;
    
public SimpleBindings()
Default constructor uses a HashMap.

        this(new HashMap<String,Object>());
    
Methods Summary
private voidcheckKey(java.lang.Object key)

        if (key == null) {
            throw new NullPointerException("key can not be null");
        }
        if (!(key instanceof String)) {
            throw new ClassCastException("key should be a String");
        }
        if (key.equals("")) {
            throw new IllegalArgumentException("key can not be empty");
        }
    
public voidclear()
{@inheritDoc}

        map.clear();
    
public booleancontainsKey(java.lang.Object key)
Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

param
key key whose presence in this map is to be tested.
return
true if this map contains a mapping for the specified key.
throws
NullPointerException if key is null
throws
ClassCastException if key is not String
throws
IllegalArgumentException if key is empty String

        checkKey(key);
        return map.containsKey(key);
    
public booleancontainsValue(java.lang.Object value)
{@inheritDoc}

        return map.containsValue(value);
    
public java.util.SetentrySet()
{@inheritDoc}

        return map.entrySet();
    
public java.lang.Objectget(java.lang.Object key)
Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

param
key key whose associated value is to be returned.
return
the value to which this map maps the specified key, or null if the map contains no mapping for this key.
throws
NullPointerException if key is null
throws
ClassCastException if key is not String
throws
IllegalArgumentException if key is empty String

        checkKey(key);
        return map.get(key);
    
public booleanisEmpty()
{@inheritDoc}

        return map.isEmpty();
    
public java.util.SetkeySet()
{@inheritDoc}

        return map.keySet();
    
public java.lang.Objectput(java.lang.String name, java.lang.Object value)
Sets the specified key/value in the underlying map field.

param
name Name of value
param
value Value to set.
return
Previous value for the specified key. Returns null if key was previously unset.
throws
NullPointerException if the name is null.
throws
IllegalArgumentException if the name is empty.

        checkKey(name);
        return map.put(name,value);
    
public voidputAll(java.util.Map toMerge)
putAll is implemented using Map.putAll.

param
toMerge The Map of values to add.
throws
NullPointerException if toMerge map is null or if some key in the map is null.
throws
IllegalArgumentException if some key in the map is an empty String.

        if (toMerge == null) {
            throw new NullPointerException("toMerge map is null");
        }
        for (Map.Entry<? extends String, ? extends Object> entry : toMerge.entrySet()) { 
            String key = entry.getKey();
            checkKey(key);
            put(key, entry.getValue());
        }
    
public java.lang.Objectremove(java.lang.Object key)
Removes the mapping for this key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

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.

param
key key whose mapping is to be removed from the map.
return
previous value associated with specified key, or null if there was no mapping for key.
throws
NullPointerException if key is null
throws
ClassCastException if key is not String
throws
IllegalArgumentException if key is empty String

        checkKey(key);
        return map.remove(key);
    
public intsize()
{@inheritDoc}

        return map.size();
    
public java.util.Collectionvalues()
{@inheritDoc}

        return map.values();