public class MDCContextMap extends Object implements CleanableThreadContextMap
Constructor and Description |
---|
MDCContextMap() |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the context.
|
boolean |
containsKey(String key)
Determines if the key is in the context.
|
String |
get(String key)
Gets the context identified by the
key parameter. |
Map<String,String> |
getCopy()
Gets a non-
null mutable copy of current thread's context Map. |
Map<String,String> |
getImmutableMapOrNull()
Returns an immutable view on the context Map or
null if the context map is empty. |
StringMap |
getReadOnlyContextData()
Returns the context data for reading.
|
boolean |
isEmpty()
Returns true if the Map is empty.
|
void |
put(String key,
String value)
Puts a context value (the
o parameter) as identified
with the key parameter into the current thread's
context map. |
void |
putAll(Map<String,String> m)
Puts all given context map entries into the current thread's
context map.
|
void |
remove(String key)
Removes the context identified by the
key
parameter. |
void |
removeAll(Iterable<String> keys)
Removes all given context map keys from the current thread's context map.
|
public void put(String key, String value)
ThreadContextMap
o
parameter) as identified
with the key
parameter into the current thread's
context map.
If the current thread does not have a context map it is created as a side effect.
put
in interface ThreadContextMap
key
- The key name.value
- The key value.public void putAll(Map<String,String> m)
ThreadContextMap2
If the current thread does not have a context map it is created as a side effect.
putAll
in interface ThreadContextMap2
m
- The map.public String get(String key)
ThreadContextMap
key
parameter.
This method has no side effects.
get
in interface ThreadContextMap
key
- The key to locate.public void remove(String key)
ThreadContextMap
key
parameter.remove
in interface ThreadContextMap
key
- The key to remove.public void removeAll(Iterable<String> keys)
CleanableThreadContextMap
If the current thread does not have a context map it is created as a side effect.
removeAll
in interface CleanableThreadContextMap
keys
- The keys.public void clear()
ThreadContextMap
clear
in interface ThreadContextMap
public boolean containsKey(String key)
ThreadContextMap
containsKey
in interface ThreadContextMap
key
- The key to locate.public Map<String,String> getCopy()
ThreadContextMap
null
mutable copy of current thread's context Map.getCopy
in interface ThreadContextMap
public Map<String,String> getImmutableMapOrNull()
ThreadContextMap
null
if the context map is empty.getImmutableMapOrNull
in interface ThreadContextMap
null
.public boolean isEmpty()
ThreadContextMap
isEmpty
in interface ThreadContextMap
public StringMap getReadOnlyContextData()
ThreadContextMap2
getReadOnlyContextData
in interface ThreadContextMap2
StringMap
Copyright © 1999-2023 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.