Class SimpleBindings

java.lang.Object
javax.script.SimpleBindings
All Implemented Interfaces:
Map<String,Object>,Bindings
public classSimpleBindingsextendsObjectimplementsBindings
A simple implementation of Bindings backed by aHashMap or some other specifiedMap.
Since:
1.6

  • Constructor Details

    • SimpleBindings

      public SimpleBindings(Map<String,Object> m)
      Constructor uses an existingMap to store the values.
      Parameters:
      m - TheMap backing thisSimpleBindings.
      Throws:
      NullPointerException - if m is null

    • SimpleBindings

      public SimpleBindings()
      Default constructor uses aHashMap.

  • Method Details

    • put

      public Object put(String name,Object value)
      Sets the specified key/value in the underlyingmap field.
      Specified by:
      put in interface Bindings
      Specified by:
      put in interface Map<String,Object>
      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 - if the name is null.
      IllegalArgumentException - if the name is empty.

    • putAll

      public void putAll(Map<? extendsString, ? extendsObject> toMerge)
      putAll is implemented usingMap.putAll.
      Specified by:
      putAll in interface Bindings
      Specified by:
      putAll in interface Map<String,Object>
      Parameters:
      toMerge - TheMap of values to add.
      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.

    • 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 in interface Map<String,Object>

    • containsKey

      public boolean containsKey(Object key)
      Returnstrue if this map contains a mapping for the specified key. More formally, returnstrue if and only if this map contains a mapping for a keyk such that(key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)
      Specified by:
      containsKey in interface Bindings
      Specified by:
      containsKey in interface Map<String,Object>
      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 - if key is null
      ClassCastException - if key is not String
      IllegalArgumentException - if key is empty String

    • containsValue

      public boolean containsValue(Object value)
      Returnstrue if this map maps one or more keys to the specified value. More formally, returnstrue if and only if this map contains at least one mapping to a valuev such thatObjects.equals(value, v). This operation will probably require time linear in the map size for most implementations of theMap interface.
      Specified by:
      containsValue in interface Map<String,Object>
      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 aSet 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 ownremove 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 theIterator.remove,Set.remove,removeAll,retainAll andclear operations. It does not support theadd oraddAll operations.
      Specified by:
      entrySet in interface Map<String,Object>
      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 ofnull does notnecessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key tonull. ThecontainsKey operation may be used to distinguish these two cases.

      More formally, if this map contains a mapping from a keyk to a valuev such 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:
      get in interface Bindings
      Specified by:
      get in interface Map<String,Object>
      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 - if key is null
      ClassCastException - if key is not String
      IllegalArgumentException - if key is empty String

    • isEmpty

      public boolean isEmpty()
      Returnstrue if this map contains no key-value mappings.
      Specified by:
      isEmpty in interface Map<String,Object>
      Returns:
      true if this map contains no key-value mappings

    • keySet

      public Set<String> keySet()
      Returns aSet 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 ownremove 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, andclear operations. It does not support theadd oraddAll operations.
      Specified by:
      keySet in interface Map<String,Object>
      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 keyk to valuev 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 associatednull with the specified key if the implementation supportsnull values.) The map will not contain a mapping for the specified key once the call returns.

      Specified by:
      remove in interface Bindings
      Specified by:
      remove in interface Map<String,Object>
      Parameters:
      key - key whose mapping is to be removed from the map.
      Returns:
      previous value associated with specified key, ornull if there was no mapping for key.
      Throws:
      NullPointerException - if key is null
      ClassCastException - if key is not String
      IllegalArgumentException - if key is empty String

    • size

      public int size()
      Returns the number of key-value mappings in this map. If the map contains more thanInteger.MAX_VALUE elements, returnsInteger.MAX_VALUE.
      Specified by:
      size in interface Map<String,Object>
      Returns:
      the number of key-value mappings in this map

    • values

      public Collection<Object> values()
      Returns aCollection 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 ownremove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via theIterator.remove,Collection.remove,removeAll,retainAll andclear operations. It does not support theadd oraddAll operations.
      Specified by:
      values in interface Map<String,Object>
      Returns:
      a collection view of the values contained in this map