Package org.apache.logging.log4j.util
Interface StringMap
-
- All Superinterfaces:
ReadOnlyStringMap
,java.io.Serializable
- All Known Subinterfaces:
IndexedStringMap
- All Known Implementing Classes:
SortedArrayStringMap
public interface StringMap extends ReadOnlyStringMap
Exposes methods to add and remove key-value pairs to and fromReadOnlyStringMap
.- Since:
- 2.7
- See Also:
ReadOnlyStringMap
-
-
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()
void
putAll(ReadOnlyStringMap source)
Copy all key-value pairs from the specifiedReadOnlyStringMap
into thisStringMap
.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.-
Methods inherited from interface org.apache.logging.log4j.util.ReadOnlyStringMap
containsKey, forEach, forEach, getValue, isEmpty, size, toMap
-
-
-
-
Method Detail
-
clear
void clear()
Removes all key-value pairs from this collection.- Throws:
java.util.ConcurrentModificationException
- some implementations may not support structural modifications to this data structure while iterating over the contents withReadOnlyStringMap.forEach(BiConsumer)
orReadOnlyStringMap.forEach(TriConsumer, Object)
.java.lang.UnsupportedOperationException
- if this collection has been frozen.
-
equals
boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.- Overrides:
equals
in classjava.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 thefreeze()
method was called will result in anUnsupportedOperationException
being thrown.
-
hashCode
int hashCode()
Returns a hash code value for the object.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- a hash code value for this object.
-
isFrozen
boolean isFrozen()
- Returns:
true
if this object has been frozen,false
otherwise
-
putAll
void putAll(ReadOnlyStringMap source)
Copy all key-value pairs from the specifiedReadOnlyStringMap
into thisStringMap
.- Parameters:
source
- theReadOnlyStringMap
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 withReadOnlyStringMap.forEach(BiConsumer)
orReadOnlyStringMap.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 benull
.value
- the value to add. Values may benull
.- Throws:
java.util.ConcurrentModificationException
- some implementations may not support structural modifications to this data structure while iterating over the contents withReadOnlyStringMap.forEach(BiConsumer)
orReadOnlyStringMap.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 benull
.- Throws:
java.util.ConcurrentModificationException
- some implementations may not support structural modifications to this data structure while iterating over the contents withReadOnlyStringMap.forEach(BiConsumer)
orReadOnlyStringMap.forEach(TriConsumer, Object)
.java.lang.UnsupportedOperationException
- if this collection has been frozen.
-
-