-
- All Known Implementing Classes:
ScriptObjectMirror,SimpleBindings
public interface Bindings extends Map<String,Object>
A mapping of key/value pairs, all of whose keys areStrings.- Since:
- 1.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontainsKey(Object key)Returnstrueif this map contains a mapping for the specified key.Objectget(Object key)Returns the value to which this map maps the specified key.Objectput(String name, Object value)Set a named value.voidputAll(Map<? extends String,? extends Object> toMerge)Adds all the mappings in a givenMapto thisBindings.Objectremove(Object key)Removes the mapping for this key from this map if it is present (optional operation).-
Methods declared in interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values
-
-
-
-
Method Detail
-
put
Object put(String name, Object value)
Set a named value.- Specified by:
putin interfaceMap<String,Object>- Parameters:
name- The name associated with the value.value- The value associated with the name.- Returns:
- The value previously associated with the given name. Returns null if no value was previously associated with the name.
- Throws:
NullPointerException- if the name is null.IllegalArgumentException- if the name is empty String.
-
putAll
void putAll(Map<? extends String,? extends Object> toMerge)
Adds all the mappings in a givenMapto thisBindings.- Specified by:
putAllin interfaceMap<String,Object>- Parameters:
toMerge- TheMapto merge with this one.- Throws:
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.
-
containsKey
boolean containsKey(Object key)
Returnstrueif this map contains a mapping for the specified key. More formally, returnstrueif and only if this map contains a mapping for a keyksuch that(key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)- Specified by:
containsKeyin interfaceMap<String,Object>- Parameters:
key- key whose presence in this map is to be tested.- Returns:
trueif this map contains a mapping for the specified key.- Throws:
NullPointerException- if key is nullClassCastException- if key is not StringIllegalArgumentException- if key is empty String
-
get
Object get(Object key)
Returns the value to which this map maps the specified key. Returnsnullif the map contains no mapping for this key. A return value ofnulldoes not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key tonull. ThecontainsKeyoperation may be used to distinguish these two cases.More formally, if this map contains a mapping from a key
kto a valuevsuch that(key==null ? k==null : key.equals(k)), then this method returnsv; otherwise it returnsnull. (There can be at most one such mapping.)- Specified by:
getin interfaceMap<String,Object>- Parameters:
key- key whose associated value is to be returned.- Returns:
- the value to which this map maps the specified key, or
nullif the map contains no mapping for this key. - Throws:
NullPointerException- if key is nullClassCastException- if key is not StringIllegalArgumentException- if key is empty String
-
remove
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 keykto valuevsuch 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
nullif the map contained no mapping for this key. (Anullreturn can also indicate that the map previously associatednullwith the specified key if the implementation supportsnullvalues.) The map will not contain a mapping for the specified key once the call returns.- Specified by:
removein interfaceMap<String,Object>- Parameters:
key- key whose mapping is to be removed from the map.- Returns:
- previous value associated with specified key, or
nullif there was no mapping for key. - Throws:
NullPointerException- if key is nullClassCastException- if key is not StringIllegalArgumentException- if key is empty String
-
-