SimpleBindings (Java SE 12 & JDK 12 ) (original) (raw)
- javax.script.SimpleBindings
All Implemented Interfaces:
[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>,[Bindings](Bindings.html "interface in javax.script")
public class SimpleBindings
extends Object
implements Bindings
A simple implementation of Bindings backed by a HashMap or some other specified Map.
Since:
1.6
Nested Class Summary
* ### Nested classes/interfaces declared in interface java.util.[Map](../../../java.base/java/util/Map.html "interface in java.util") `[Map.Entry](../../../java.base/java/util/Map.Entry.html "interface in java.util")<[K](../../../java.base/java/util/Map.Entry.html "type parameter in Map.Entry"),[V](../../../java.base/java/util/Map.Entry.html "type parameter in Map.Entry")>`Constructor Summary
Constructors
Constructor Description SimpleBindings() Default constructor uses a HashMap. SimpleBindings(Map<String,Object> m) Constructor uses an existing Map to store the values. Method Summary
Modifier and Type Method Description boolean containsKey(Object key) Returns true if this map contains a mapping for the specified key. Object get(Object key) Returns the value to which this map maps the specified key. Object put(String name,Object value) Sets the specified key/value in the underlying map field. void putAll(Map<? extends String,? extends Object> toMerge) putAll is implemented using Map.putAll. Object remove(Object key) Removes the mapping for this key from this map if it is present (optional operation). * ### Methods declared in class java.lang.[Object](../../../java.base/java/lang/Object.html "class in java.lang") `[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)` * ### Methods declared in interface java.util.[Map](../../../java.base/java/util/Map.html "interface in java.util") `[clear](../../../java.base/java/util/Map.html#clear%28%29), [compute](../../../java.base/java/util/Map.html#compute%28K,java.util.function.BiFunction%29), [computeIfAbsent](../../../java.base/java/util/Map.html#computeIfAbsent%28K,java.util.function.Function%29), [computeIfPresent](../../../java.base/java/util/Map.html#computeIfPresent%28K,java.util.function.BiFunction%29), [containsValue](../../../java.base/java/util/Map.html#containsValue%28java.lang.Object%29), [entrySet](../../../java.base/java/util/Map.html#entrySet%28%29), [equals](../../../java.base/java/util/Map.html#equals%28java.lang.Object%29), [forEach](../../../java.base/java/util/Map.html#forEach%28java.util.function.BiConsumer%29), [getOrDefault](../../../java.base/java/util/Map.html#getOrDefault%28java.lang.Object,V%29), [hashCode](../../../java.base/java/util/Map.html#hashCode%28%29), [isEmpty](../../../java.base/java/util/Map.html#isEmpty%28%29), [keySet](../../../java.base/java/util/Map.html#keySet%28%29), [merge](../../../java.base/java/util/Map.html#merge%28K,V,java.util.function.BiFunction%29), [putIfAbsent](../../../java.base/java/util/Map.html#putIfAbsent%28K,V%29), [remove](../../../java.base/java/util/Map.html#remove%28java.lang.Object,java.lang.Object%29), [replace](../../../java.base/java/util/Map.html#replace%28K,V%29), [replace](../../../java.base/java/util/Map.html#replace%28K,V,V%29), [replaceAll](../../../java.base/java/util/Map.html#replaceAll%28java.util.function.BiFunction%29), [size](../../../java.base/java/util/Map.html#size%28%29), [values](../../../java.base/java/util/Map.html#values%28%29)`Constructor Detail
* #### SimpleBindings public SimpleBindings([Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")> m) Constructor uses an existing `Map` to store the values. Parameters: `m` \- The `Map` backing this `SimpleBindings`. Throws: `[NullPointerException](../../../java.base/java/lang/NullPointerException.html "class in java.lang")` \- if m is null * #### SimpleBindings public SimpleBindings() Default constructor uses a `HashMap`.Method Detail
* #### put public [Object](../../../java.base/java/lang/Object.html "class in java.lang") put([String](../../../java.base/java/lang/String.html "class in java.lang") name, [Object](../../../java.base/java/lang/Object.html "class in java.lang") value) Sets the specified key/value in the underlying `map` field. Specified by: `[put](Bindings.html#put%28java.lang.String,java.lang.Object%29)` in interface `[Bindings](Bindings.html "interface in javax.script")` Specified by: `[put](../../../java.base/java/util/Map.html#put%28K,V%29)` in interface `[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>` 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.base/java/lang/NullPointerException.html "class in java.lang")` \- if the name is null. `[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- if the name is empty. * #### putAll public void putAll([Map](../../../java.base/java/util/Map.html "interface in java.util")<? extends [String](../../../java.base/java/lang/String.html "class in java.lang"),? extends [Object](../../../java.base/java/lang/Object.html "class in java.lang")> toMerge) `putAll` is implemented using `Map.putAll`. Specified by: `[putAll](Bindings.html#putAll%28java.util.Map%29)` in interface `[Bindings](Bindings.html "interface in javax.script")` Specified by: `[putAll](../../../java.base/java/util/Map.html#putAll%28java.util.Map%29)` in interface `[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>` Parameters: `toMerge` \- The `Map` of values to add. Throws: `[NullPointerException](../../../java.base/java/lang/NullPointerException.html "class in java.lang")` \- if toMerge map is null or if some key in the map is null. `[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- if some key in the map is an empty String. * #### containsKey public boolean containsKey([Object](../../../java.base/java/lang/Object.html "class in java.lang") 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](Bindings.html#containsKey%28java.lang.Object%29)` in interface `[Bindings](Bindings.html "interface in javax.script")` Specified by: `[containsKey](../../../java.base/java/util/Map.html#containsKey%28java.lang.Object%29)` in interface `[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>` 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.base/java/lang/NullPointerException.html "class in java.lang")` \- if key is null `[ClassCastException](../../../java.base/java/lang/ClassCastException.html "class in java.lang")` \- if key is not String `[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- if key is empty String * #### get public [Object](../../../java.base/java/lang/Object.html "class in java.lang") get([Object](../../../java.base/java/lang/Object.html "class in java.lang") 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.) Specified by: `[get](Bindings.html#get%28java.lang.Object%29)` in interface `[Bindings](Bindings.html "interface in javax.script")` Specified by: `[get](../../../java.base/java/util/Map.html#get%28java.lang.Object%29)` in interface `[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>` Parameters: `key` \- key whose associated value is to be returned. Returns: the value to which this map maps the specified key, or`null` if the map contains no mapping for this key. Throws: `[NullPointerException](../../../java.base/java/lang/NullPointerException.html "class in java.lang")` \- if key is null `[ClassCastException](../../../java.base/java/lang/ClassCastException.html "class in java.lang")` \- if key is not String `[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- if key is empty String * #### remove public [Object](../../../java.base/java/lang/Object.html "class in java.lang") remove([Object](../../../java.base/java/lang/Object.html "class in java.lang") 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. Specified by: `[remove](Bindings.html#remove%28java.lang.Object%29)` in interface `[Bindings](Bindings.html "interface in javax.script")` Specified by: `[remove](../../../java.base/java/util/Map.html#remove%28java.lang.Object%29)` in interface `[Map](../../../java.base/java/util/Map.html "interface in java.util")<[String](../../../java.base/java/lang/String.html "class in java.lang"),[Object](../../../java.base/java/lang/Object.html "class in java.lang")>` 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.base/java/lang/NullPointerException.html "class in java.lang")` \- if key is null `[ClassCastException](../../../java.base/java/lang/ClassCastException.html "class in java.lang")` \- if key is not String `[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- if key is empty String
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.