org.apache.logging.log4j.spi
Class DefaultThreadContextMap

java.lang.Object
  org.apache.logging.log4j.spi.DefaultThreadContextMap

All Implemented Interfaces:

ThreadContextMap

public class DefaultThreadContextMap
extends Object
implements ThreadContextMap

Constructor Summary

DefaultThreadContextMap(boolean useMap)

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 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultThreadContextMap

public DefaultThreadContextMap(boolean useMap)

Method Detail

put

public 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.

Specified by:

put in interface ThreadContextMap

Parameters:

key - The key name.

value - The key value.

get

public String get(String key)

Get the context identified by the key parameter.

This method has no side effects.

Specified by:

get in interface ThreadContextMap

Parameters:

key - The key to locate.

Returns:

The value associated with the key or null.

remove

public void remove(String key)

Remove the the context identified by the key parameter.

Specified by:

remove in interface ThreadContextMap

Parameters:

key - The key to remove.

clear

public void clear()

Clear the context.

Specified by:

clear in interface ThreadContextMap

containsKey

public boolean containsKey(String key)

Determine if the key is in the context.

Specified by:

containsKey in interface ThreadContextMap

Parameters:

key - The key to locate.

Returns:

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

getContext

public Map<String,String> getContext()

Get a copy of current thread's context Map.

Specified by:

getContext in interface ThreadContextMap

Returns:

a copy of the context.

get

public Map<String,String> get()

Return the context Map.

Specified by:

get in interface ThreadContextMap

Returns:

the Context Map.

isEmpty

public boolean isEmpty()

Returns true if the Map is empty.

Specified by:

isEmpty in interface ThreadContextMap

Returns:

true if the Map is empty, false otherwise.