Package org.apache.logging.log4j.spi

Interface ObjectThreadContextMap

All Superinterfaces:

CleanableThreadContextMap, ThreadContextMap, ThreadContextMap2

public interface ObjectThreadContextMap
extends CleanableThreadContextMap

Extension service provider interface to allow putting Object values in the ThreadContext.

Since:

2.8

See Also:

ThreadContextMap

Method Summary

Modifier and Type	Method	Description
<V> V	getValue(String key)	Returns the Object value for the specified key, or null if the specified key does not exist in this collection.
<V> void	putAllValues(Map<String,V> values)	Puts all given key-value pairs into the collection.
<V> void	putValue(String key, V value)	Puts the specified key-value pair into the collection.

Methods inherited from interface org.apache.logging.log4j.spi.CleanableThreadContextMap

removeAll

Methods inherited from interface org.apache.logging.log4j.spi.ThreadContextMap

clear, containsKey, get, getCopy, getImmutableMapOrNull, isEmpty, put, remove

Methods inherited from interface org.apache.logging.log4j.spi.ThreadContextMap2

getReadOnlyContextData, putAll

Method Detail

getValue

<V> V getValue(String key)

Returns the Object value for the specified key, or null if the specified key does not exist in this collection.

Parameters:

key - the key whose value to return

Returns:

the value for the specified key or null

putValue

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

putAllValues

<V> void putAllValues(Map<String,V> values)

Puts all given key-value pairs into the collection.

Parameters:

values - the map of key-value pairs to add