OpenJDK 27 · javax.script.SimpleBindings · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final Map<String, Object>	map The `Map` field stores the attributes.

Access	Constructor and Description
public	SimpleBindings(Map<String, Object> The `Map` backing this `SimpleBindings`. m) Constructor uses an existing `Map` to store the values.
public	SimpleBindings() Default constructor uses a `HashMap`.

Method Summary

Modifier and Type	Method and Description
private void	checkKey(Object key)
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
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) Implements javax.script.Bindings.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(Object value) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public Set<Map.Entry<String, Object>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
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) Implements javax.script.Bindings.get. Returns the value to which this map maps the specified key.
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<String>	keySet() Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public Object	Returns: Previous value for the specified key. Returns null if key was previously unset. put(String Name of value name, Object Value to set. value) Implements javax.script.Bindings.put. Sets the specified key/value in the underlying `map` field.
public void	putAll(Map<? extends String, ? extends Object> The `Map` of values to add. toMerge) Implements javax.script.Bindings.putAll. `putAll` is implemented using `Map.putAll`.
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) Implements javax.script.Bindings.remove. Removes the mapping for this key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public Collection<Object>	values() Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

map	back to summary
private final Map<String, Object> map The `Map` field stores the attributes.

SimpleBindings	back to summary
public SimpleBindings(Map<String, Object> m) Constructor uses an existing `Map` to store the values. Parameters m:Map<String, Object> The `Map` backing this `SimpleBindings`. Exceptions NullPointerException: if m is null

SimpleBindings	back to summary
public SimpleBindings() Default constructor uses a `HashMap`.

Method Detail

checkKey	back to summary
private void checkKey(Object key)

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

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

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Implements javax.script.Bindings.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

public boolean containsKey(Object key)

Implements javax.script.Bindings.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

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. 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 `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface.

public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

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 Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, Object>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.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 the `setValue` 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` and `clear` operations. It does not support the `add` or `addAll` operations.

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

Implements java.util.Map.entrySet.

Doc from java.util.Map.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 the setValue 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 and clear operations. It does not support the add or addAll operations.

get back to summary

get	back to summary
public Object get(Object key) Implements javax.script.Bindings.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

public Object get(Object key)

Implements javax.script.Bindings.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

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

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

keySet back to summary

keySet	back to summary
public Set<String> keySet() Implements java.util.Map.keySet. Doc from java.util.Map.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 the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll`, and `clear` operations. It does not support the `add` or `addAll` operations.

public Set<String> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.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 the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

put back to summary

put	back to summary
public Object put(String name, Object value) Implements javax.script.Bindings.put. Sets the specified key/value in the underlying `map` field. Parameters name:String Name of value value:Object Value to set. Returns:Object Previous value for the specified key. Returns null if key was previously unset. Exceptions NullPointerException: if the name is null. IllegalArgumentException: if the name is empty.

public Object put(String name, Object value)

Implements javax.script.Bindings.put.

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

Parameters

name:String: Name of value
value:Object: Value to set.

Returns:Object

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

Exceptions

NullPointerException:: if the name is null.
IllegalArgumentException:: if the name is empty.

putAll back to summary

putAll	back to summary
public void putAll(Map<? extends String, ? extends Object> toMerge) Implements javax.script.Bindings.putAll. `putAll` is implemented using `Map.putAll`. Parameters toMerge:Map<? extends String, ? extends Object> The `Map` of values to add. 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.

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

Implements javax.script.Bindings.putAll.

putAll is implemented using Map.putAll.

Parameters

toMerge:Map<? extends String, ? extends Object>: The Map of values to add.

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.

remove back to summary

remove	back to summary
public Object remove(Object key) Implements javax.script.Bindings.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

public Object remove(Object key)

Implements javax.script.Bindings.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

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`.

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

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

values back to summary

values	back to summary
public Collection<Object> values() Implements java.util.Map.values. Doc from java.util.Map.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.

public Collection<Object> values()

Implements java.util.Map.values.

Doc from java.util.Map.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.

public Class SimpleBindings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail