Package org.apache.logging.log4j.spi
Class NoOpThreadContextMap
- java.lang.Object
-
- org.apache.logging.log4j.spi.NoOpThreadContextMap
-
- All Implemented Interfaces:
ThreadContextMap
public class NoOpThreadContextMap extends java.lang.Object implements ThreadContextMap
ThreadContextMap
implementation used when either of system propertiesdisableThreadContextMap
or .disableThreadContext
istrue
. This implementation does nothing.- Since:
- 2.7
-
-
Constructor Summary
Constructors Constructor Description NoOpThreadContextMap()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears the context.boolean
containsKey(java.lang.String key)
Determines if the key is in the context.java.lang.String
get(java.lang.String key)
Gets the context identified by thekey
parameter.java.util.Map<java.lang.String,java.lang.String>
getCopy()
Gets a non-null
mutable copy of current thread's context Map.java.util.Map<java.lang.String,java.lang.String>
getImmutableMapOrNull()
Returns an immutable view on the context Map ornull
if the context map is empty.boolean
isEmpty()
Returns true if the Map is empty.void
put(java.lang.String key, java.lang.String value)
Puts a context value (theo
parameter) as identified with thekey
parameter into the current thread's context map.void
remove(java.lang.String key)
Removes the context identified by thekey
parameter.
-
-
-
Method Detail
-
clear
public void clear()
Description copied from interface:ThreadContextMap
Clears the context.- Specified by:
clear
in interfaceThreadContextMap
-
containsKey
public boolean containsKey(java.lang.String key)
Description copied from interface:ThreadContextMap
Determines if the key is in the context.- Specified by:
containsKey
in interfaceThreadContextMap
- Parameters:
key
- The key to locate.- Returns:
- True if the key is in the context, false otherwise.
-
get
public java.lang.String get(java.lang.String key)
Description copied from interface:ThreadContextMap
Gets the context identified by thekey
parameter.This method has no side effects.
- Specified by:
get
in interfaceThreadContextMap
- Parameters:
key
- The key to locate.- Returns:
- The value associated with the key or null.
-
getCopy
public java.util.Map<java.lang.String,java.lang.String> getCopy()
Description copied from interface:ThreadContextMap
Gets a non-null
mutable copy of current thread's context Map.- Specified by:
getCopy
in interfaceThreadContextMap
- Returns:
- a mutable copy of the context.
-
getImmutableMapOrNull
public java.util.Map<java.lang.String,java.lang.String> getImmutableMapOrNull()
Description copied from interface:ThreadContextMap
Returns an immutable view on the context Map ornull
if the context map is empty.- Specified by:
getImmutableMapOrNull
in interfaceThreadContextMap
- Returns:
- an immutable context Map or
null
.
-
isEmpty
public boolean isEmpty()
Description copied from interface:ThreadContextMap
Returns true if the Map is empty.- Specified by:
isEmpty
in interfaceThreadContextMap
- Returns:
- true if the Map is empty, false otherwise.
-
put
public void put(java.lang.String key, java.lang.String value)
Description copied from interface:ThreadContextMap
Puts a context value (theo
parameter) as identified with thekey
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.
- Specified by:
put
in interfaceThreadContextMap
- Parameters:
key
- The key name.value
- The key value.
-
remove
public void remove(java.lang.String key)
Description copied from interface:ThreadContextMap
Removes the context identified by thekey
parameter.- Specified by:
remove
in interfaceThreadContextMap
- Parameters:
key
- The key to remove.
-
-