Package org.tinylog.provider

Interface ContextProvider

public interface ContextProvider

API for accessing thread-based mapped diagnostic context of concrete logging framework implementation.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all existing values from thread context.
java.lang.String	get(java.lang.String key)	Gets a value by key from thread context.
java.util.Map<java.lang.String,java.lang.String>	getMapping()	Gets a read-only copy with all values from thread context.
void	put(java.lang.String key, java.lang.Object value)	Stores a value in thread context.
void	remove(java.lang.String key)	Removes a value from thread context.

Method Detail

getMapping

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

Gets a read-only copy with all values from thread context.

Returns:

Read-only copy

get

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

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

void remove(java.lang.String key)

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

Parameters:

key - Key of mapping

clear

void clear()

Removes all existing values from thread context.