Package org.pmw.tinylog

Class LoggingContext

java.lang.Object

org.pmw.tinylog.LoggingContext

public final class LoggingContext
extends java.lang.Object

Thread-based mapped diagnostic context for logging. A child thread automatically inherits a copy of the mapped diagnostic context of its parent.

If logging context is used in 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()	Remove all existing context values.
static java.lang.String	get(java.lang.String key)	Get the context value by a key.
static java.util.Map<java.lang.String,java.lang.String>	getMapping()	Get a read-only map with all context values.
static void	put(java.lang.String key, java.lang.Object value)	Put a new context value.
static void	remove(java.lang.String key)	Remove a context value if existing.

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()

Get a read-only map with all context values.

Returns:

Read-only map

get

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

Get the context value by a key.

Parameters:

key - Key of mapping

Returns:

Context value or null

put

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

Put a new context value.

Parameters:

key - Key of mapping

value - New value

remove

public static void remove(java.lang.String key)

Remove a context value if existing.

Parameters:

key - Key of mapping

clear

public static void clear()

Remove all existing context values.