org.apache.logging.log4j.spi
Interface ThreadContextMap

All Known Implementing Classes:

DefaultThreadContextMap

public interface ThreadContextMap

Method Summary

void	clear() Clear the context.
boolean	containsKey(String key) Determine if the key is in the context.
Map<String,String>	get() Return the actual context Map.
String	get(String key) Get the context identified by the key parameter.
Map<String,String>	getContext() Get a copy of current thread's context Map.
boolean	isEmpty() Returns true if the Map is empty.
void	put(String key, String value) Put a context value (the o parameter) as identified with the key parameter into the current thread's context map.
void	remove(String key) Remove the the context identified by the key parameter.

Method Detail

put

void put(String key,
         String value)

Put a context value (the o parameter) as identified with the key parameter into the current thread's context map.

If the current thread does not have a context map it is created as a side effect.

Parameters:

key - The key name.

value - The key value.

get

String get(String key)

Get the context identified by the key parameter.

This method has no side effects.

Parameters:

key - The key to locate.

Returns:

The value associated with the key or null.

remove

void remove(String key)

Remove the the context identified by the key parameter.

Parameters:

key - The key to remove.

clear

void clear()

Clear the context.

containsKey

boolean containsKey(String key)

Determine if the key is in the context.

Parameters:

key - The key to locate.

Returns:

True if the key is in the context, false otherwise.

getContext

Map<String,String> getContext()

Get a copy of current thread's context Map.

Returns:

a copy of the context.

get

Map<String,String> get()

Return the actual context Map.

Returns:

the actual context Map.

isEmpty

boolean isEmpty()

Returns true if the Map is empty.

Returns:

true if the Map is empty, false otherwise.