Interface Bindings

All Superinterfaces:
Map<String,Object>
All Known Implementing Classes:
SimpleBindings
public interfaceBindingsextendsMap<String,Object>
A mapping of key/value pairs, all of whose keys areStrings.
Since:
1.6

  • Method Details

    • put

      Object put(String name,Object value)
      Set a named value.
      Specified by:
      put in interface Map<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<? extendsString, ? extendsObject> toMerge)
      Adds all the mappings in a givenMap to thisBindings.
      Specified by:
      putAll in interface Map<String,Object>
      Parameters:
      toMerge - TheMap to 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)
      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 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

    • get

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

    • 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 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 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