Module org.tinylog.api

Package org.tinylog

Class ThreadContext

java.lang.Object

org.tinylog.ThreadContext

public final class ThreadContext
extends java.lang.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.

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	Description
static void	clear()	Removes all existing values from thread context.
static java.lang.String	get(java.lang.String key)	Gets a value by key from thread context.
static java.util.Map<java.lang.String,java.lang.String>	getMapping()	Gets all values that are visible for the current thread from thread context.
static void	put(java.lang.String key, java.lang.Object value)	Stores a value in thread context.
static void	remove(java.lang.String key)	Removes a value from thread context.

Methods inherited from class java.lang.Object

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

Method Detail

getMapping

public static java.util.Map<java.lang.String,java.lang.String> getMapping()

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

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

Returns:

All stored values

get

public static java.lang.String get(java.lang.String key)

Gets a value by key from thread context.

Parameters:

key - Key of mapping

Returns:

Found value or null

put

public static void put(java.lang.String key,
                       java.lang.Object value)

Stores a value in thread 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(java.lang.String key)

Removes a value from thread 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 thread context.