Top Description Methods
javax.script

public Interface Bindings

extends Map<String, Object>
Known Direct Implementers
javax.script.SimpleBindings
Imports
java.util.Map

A mapping of key/value pairs, all of whose keys are Strings.
Author
Mike Grogan
Since
1.6

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if this map contains a mapping for the specified key.
containsKey
(Object
key whose presence in this map is to be tested.
key
)

Redeclares java.util.Map.containsKey.

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

Returns:

the value to which this map maps the specified key, or null if the map contains no mapping for this key.
get
(Object
key whose associated value is to be returned.
key
)

Redeclares java.util.Map.get.

Returns the value to which this map maps the specified key.
public Object

Returns:

The value previously associated with the given name. Returns null if no value was previously associated with the name.
put
(String
The name associated with the value.
name
,
Object
The value associated with the name.
value
)

Redeclares java.util.Map.put.

Set a named value.
public void
putAll(Map<? extends String, ? extends Object>
The Map to merge with this one.
toMerge
)

Redeclares java.util.Map.putAll.

Adds all the mappings in a given Map to this Bindings.
public Object

Returns:

previous value associated with specified key, or null if there was no mapping for key.
remove
(Object
key whose mapping is to be removed from the map.
key
)

Redeclares java.util.Map.remove.

Removes the mapping for this key from this map if it is present (optional operation).
Inherited from java.util.Map:
clearcomputecomputeIfAbsentcomputeIfPresentcontainsValuecopyOfentryentrySetequalsforEachgetOrDefaulthashCodeisEmptykeySetmergeofofofofofofofofofofofofEntriesputIfAbsentremovereplacereplacereplaceAllsizevalues

Method Detail

containsKeyback to summary
public boolean containsKey(Object key)

Redeclares java.util.Map.containsKey.

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.)

Parameters
key:Object

key whose presence in this map is to be tested.

Returns:boolean

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

Exceptions
NullPointerException:
if key is null
ClassCastException:
if key is not String
IllegalArgumentException:
if key is empty String
getback to summary
public Object get(Object key)

Redeclares java.util.Map.get.

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.)

Parameters
key:Object

key whose associated value is to be returned.

Returns:Object

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

Exceptions
NullPointerException:
if key is null
ClassCastException:
if key is not String
IllegalArgumentException:
if key is empty String
putback to summary
public Object put(String name, Object value)

Redeclares java.util.Map.put.

Set a named value.

Parameters
name:String

The name associated with the value.

value:Object

The value associated with the name.

Returns:Object

The value previously associated with the given name. Returns null if no value was previously associated with the name.

Exceptions
NullPointerException:
if the name is null.
IllegalArgumentException:
if the name is empty String.
putAllback to summary
public void putAll(Map<? extends String, ? extends Object> toMerge)

Redeclares java.util.Map.putAll.

Adds all the mappings in a given Map to this Bindings.

Parameters
toMerge:Map<? extends String, ? extends Object>

The Map to merge with this one.

Exceptions
NullPointerException:
if toMerge map is null or if some key in the map is null.
IllegalArgumentException:
if some key in the map is an empty String.
removeback to summary
public Object remove(Object key)

Redeclares java.util.Map.remove.

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.

Parameters
key:Object

key whose mapping is to be removed from the map.

Returns:Object

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

Exceptions
NullPointerException:
if key is null
ClassCastException:
if key is not String
IllegalArgumentException:
if key is empty String