SimpleBindings (Java Platform SE 6) (original) (raw)

javax.script

Class SimpleBindings

java.lang.Object javax.script.SimpleBindings

All Implemented Interfaces:

Map<String,Object>, Bindings

public class SimpleBindings

extends Object

implements Bindings

A simple implementation of Bindings backed by a HashMap or some other specified Map.

Since:

1.6

SimpleBindings

public SimpleBindings(Map<String,Object> m)

Constructor uses an existing Map to store the values.

Parameters:

m - The Map backing this SimpleBindings.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if m is null

SimpleBindings

public SimpleBindings()

Default constructor uses a HashMap.

put

public Object put(String name, Object value)

Sets the specified key/value in the underlying map field.

Specified by:

[put](../../java/util/Map.html#put%28K, V%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Specified by:

[put](../../javax/script/Bindings.html#put%28java.lang.String, java.lang.Object%29) in interface [Bindings](../../javax/script/Bindings.html "interface in javax.script")

Parameters:

name - Name of value

value - Value to set.

Returns:

Previous value for the specified key. Returns null if key was previously unset.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the name is null.

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the name is empty.

putAll

public void putAll(Map<? extends String,? extends Object> toMerge)

putAll is implemented using Map.putAll.

Specified by:

[putAll](../../java/util/Map.html#putAll%28java.util.Map%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Specified by:

[putAll](../../javax/script/Bindings.html#putAll%28java.util.Map%29) in interface [Bindings](../../javax/script/Bindings.html "interface in javax.script")

Parameters:

toMerge - The Map of values to add.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if toMerge map is null or if some key in the map is null.

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if some key in the map is an empty String.

clear

public void clear()

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

[clear](../../java/util/Map.html#clear%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

containsKey

public boolean containsKey(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.)

Specified by:

[containsKey](../../java/util/Map.html#containsKey%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Specified by:

[containsKey](../../javax/script/Bindings.html#containsKey%28java.lang.Object%29) in interface [Bindings](../../javax/script/Bindings.html "interface in javax.script")

Parameters:

key - key whose presence in this map is to be tested.

Returns:

true if this map contains a mapping for the specified key.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if key is null

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if key is not String

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if key is empty String

containsValue

public boolean containsValue(Object value)

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.

Specified by:

[containsValue](../../java/util/Map.html#containsValue%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Returns a Set view of the mappings contained in this map. 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 thesetValue 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 andclear operations. It does not support theadd or addAll operations.

Specified by:

[entrySet](../../java/util/Map.html#entrySet%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Returns:

a set view of the mappings contained in this map

get

public Object get(Object key)

Returns the value to which this map maps the specified key. Returnsnull 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 keyk 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.)

Specified by:

[get](../../java/util/Map.html#get%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Specified by:

[get](../../javax/script/Bindings.html#get%28java.lang.Object%29) in interface [Bindings](../../javax/script/Bindings.html "interface in javax.script")

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key, ornull if the map contains no mapping for this key.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if key is null

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if key is not String

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if key is empty String

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

[isEmpty](../../java/util/Map.html#isEmpty%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Returns:

true if this map contains no key-value mappings

keySet

public Set<String> keySet()

Returns a Set view of the keys contained in this map. 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), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove, Set.remove,removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

[keySet](../../java/util/Map.html#keySet%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Returns:

a set view of the keys contained in this map

remove

public Object remove(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, ornull if the map contained no mapping for this key. (Anull 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.

Specified by:

[remove](../../java/util/Map.html#remove%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Specified by:

[remove](../../javax/script/Bindings.html#remove%28java.lang.Object%29) in interface [Bindings](../../javax/script/Bindings.html "interface in javax.script")

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

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

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if key is null

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if key is not String

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if key is empty String

size

public int size()

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returnsInteger.MAX_VALUE.

Specified by:

[size](../../java/util/Map.html#size%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Returns:

the number of key-value mappings in this map

values

public Collection<Object> values()

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove,Collection.remove, removeAll,retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

[values](../../java/util/Map.html#values%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang"),[Object](../../java/lang/Object.html "class in java.lang")>

Returns:

a collection view of the values contained in this map

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.