Interface StringMap

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()
      Removes all key-value pairs from this collection.
      boolean equals​(java.lang.Object obj)
      Indicates whether some other object is "equal to" this one.
      void freeze()
      Makes this collection immutable.
      int hashCode()
      Returns a hash code value for the object.
      boolean isFrozen()
      Returns true if this object has been frozen, false otherwise.
      void putAll​(ReadOnlyStringMap source)
      Copy all key-value pairs from the specified ReadOnlyStringMap into this StringMap.
      void putValue​(java.lang.String key, java.lang.Object value)
      Puts the specified key-value pair into the collection.
      void remove​(java.lang.String key)
      Removes the key-value pair for the specified key from this data structure.
    • Method Detail

      • equals

        boolean equals​(java.lang.Object obj)
        Indicates whether some other object is "equal to" this one.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        hashCode()
      • freeze

        void freeze()
        Makes this collection immutable. Attempts to modify the collection after the freeze() method was called will result in an UnsupportedOperationException being thrown.
      • hashCode

        int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
      • isFrozen

        boolean isFrozen()
        Returns true if this object has been frozen, false otherwise.
        Returns:
        true if this object has been frozen, false otherwise
      • putAll

        void putAll​(ReadOnlyStringMap source)
        Copy all key-value pairs from the specified ReadOnlyStringMap into this StringMap.
        Parameters:
        source - the ReadOnlyStringMap to copy key-value pairs from
        Throws:
        java.util.ConcurrentModificationException - some implementations may not support structural modifications to this data structure while iterating over the contents with ReadOnlyStringMap.forEach(BiConsumer) or ReadOnlyStringMap.forEach(TriConsumer, Object).
        java.lang.UnsupportedOperationException - if this collection has been frozen.
      • putValue

        void putValue​(java.lang.String key,
                      java.lang.Object value)
        Puts the specified key-value pair into the collection.
        Parameters:
        key - the key to add or remove. Keys may be null.
        value - the value to add. Values may be null.
        Throws:
        java.util.ConcurrentModificationException - some implementations may not support structural modifications to this data structure while iterating over the contents with ReadOnlyStringMap.forEach(BiConsumer) or ReadOnlyStringMap.forEach(TriConsumer, Object).
        java.lang.UnsupportedOperationException - if this collection has been frozen.
      • remove

        void remove​(java.lang.String key)
        Removes the key-value pair for the specified key from this data structure.
        Parameters:
        key - the key to remove. May be null.
        Throws:
        java.util.ConcurrentModificationException - some implementations may not support structural modifications to this data structure while iterating over the contents with ReadOnlyStringMap.forEach(BiConsumer) or ReadOnlyStringMap.forEach(TriConsumer, Object).
        java.lang.UnsupportedOperationException - if this collection has been frozen.