Package org.apache.logging.log4j.spi

Class NoOpThreadContextMap

java.lang.Object

org.apache.logging.log4j.spi.NoOpThreadContextMap

All Implemented Interfaces:

ThreadContextMap

@NullMarked
public class NoOpThreadContextMap
extends Object
implements ThreadContextMap

ThreadContextMap implementation used when either of system properties disableThreadContextMap or . disableThreadContext is true. This implementation does nothing.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field	Description
static final ThreadContextMap	INSTANCE

Constructor Summary

Constructors

Constructor	Description
NoOpThreadContextMap()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the context.
boolean	containsKey(String key)	Determines if the key is in the context.
@Nullable 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.
@Nullable Map<String,String>	getImmutableMapOrNull()	Returns an immutable view on the context Map or null if the context map is empty.
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	remove(String key)	Removes the context identified by the key parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final ThreadContextMap INSTANCE

Since:

2.24.0

Constructor Details

NoOpThreadContextMap

public NoOpThreadContextMap()

Method Details

clear

public void clear()

Description copied from interface: ThreadContextMap

Clears the context.

Specified by:

clear in interface ThreadContextMap

containsKey

public boolean containsKey(String key)

Description copied from interface: ThreadContextMap

Determines if the key is in the context.

Specified by:

containsKey in interface ThreadContextMap

Parameters:

key - The key to locate.

Returns:

True if the key is in the context, false otherwise.

get

public @Nullable String get(String key)

Description copied from interface: ThreadContextMap

Gets the context identified by the key parameter.

This method has no side effects.

Specified by:

get in interface ThreadContextMap

Parameters:

key - The key to locate.

Returns:

The value associated with the key or null.

getCopy

public Map<String,String> getCopy()

Description copied from interface: ThreadContextMap

Gets a non-null mutable copy of current thread's context Map.

Specified by:

getCopy in interface ThreadContextMap

Returns:

a mutable copy of the context.

getImmutableMapOrNull

public @Nullable Map<String,String> getImmutableMapOrNull()

Description copied from interface: ThreadContextMap

Returns an immutable view on the context Map or null if the context map is empty.

Specified by:

getImmutableMapOrNull in interface ThreadContextMap

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 interface ThreadContextMap

Returns:

true if the Map is empty, false otherwise.

put

public void put(String key,
 String value)

Description copied from interface: ThreadContextMap

Puts a context value (the 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.

Specified by:

put in interface ThreadContextMap

Parameters:

key - The key name.

value - The key value.

remove

public void remove(String key)

Description copied from interface: ThreadContextMap

Removes the context identified by the key parameter.

Specified by:

remove in interface ThreadContextMap

Parameters:

key - The key to remove.