org.pmw.tinylog

Class LoggingContext

java.lang.Object

org.pmw.tinylog.LoggingContext

public final class LoggingContext
extends Object

Thread-based mapped diagnostic context for enriching log entries with additional values. A stored value is only visible for the thread, in which this value has been set, and its child threads.

Logging context is a wrapper for ThreadContext. Therefore, all operations also affect the ThreadContext and vice versa.

If values will be stored by a thread from a thread pool, clear() should be called before putting the thread back to the pool.

Method Summary

Modifier and Type	Method and Description
static void	clear() Removes all existing values from logging context.
static String	get(String key) Gets a value by key from logging context.
static Map<String,String>	getMapping() Gets all values that are visible for the current thread from logging context.
static void	put(String key, Object value) Stores a value in logging context.
static void	remove(String key) Removes a value from logging context.

Methods inherited from class java.lang.Object

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

Method Detail

getMapping

public static Map<String,String> getMapping()

Gets all values that are visible for the current thread from logging context.

The returned map is either read-only or a mutable copy. It cannot used to modify the logging context itself.

Returns:

All stored values

get

public static String get(String key)

Gets a value by key from logging context.

Parameters:

key - Key of mapping

Returns:

Found value or null

put

public static void put(String key,
                       Object value)

Stores a value in logging context. If the key already exists, the original value will be overridden.

Parameters:

key - Key of mapping

value - Value of mapping

remove

public static void remove(String key)

Removes a value from logging context. If there is no mapping with the given key, this method will just quit silently.

Parameters:

key - Key of mapping

clear

public static void clear()

Removes all existing values from logging context.