Method Detail

• clear

  void clear()

  Removes all key-value pairs from this collection.

  Throws:

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

  UnsupportedOperationException - if this collection has been frozen.

• equals

  boolean equals(Object obj)

  Indicates whether some other object is "equal to" this one.

  Overrides:

  equals in class 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 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)

  Copies all key-value pairs from the specified ReadOnlyStringMap into this StringMap.

  Parameters:

  source - the ReadOnlyStringMap to copy key-value pairs from

  Throws:

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

  UnsupportedOperationException - if this collection has been frozen.

• putValue

  void putValue(String key,
              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:

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

  UnsupportedOperationException - if this collection has been frozen.

• remove

  void remove(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:

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

  UnsupportedOperationException - if this collection has been frozen.