org.ops4j.pax.logging.log4jv2

Class Log4jv2ThreadContextMap

java.lang.Object

org.ops4j.pax.logging.log4jv2.Log4jv2ThreadContextMap

All Implemented Interfaces:

ThreadContextMap

public class Log4jv2ThreadContextMap
extends java.lang.Object
implements ThreadContextMap

The actual ThreadContext Map. A new ThreadContext Map is created each time it is updated and the Map stored is always immutable. This means the Map can be passed to other threads without concern that it will be updated. Since it is expected that the Map will be passed to many more log events than the number of keys it contains the performance should be much better than if the Map was copied for each event.

Constructor Summary

Constructors

Constructor and Description
Log4jv2ThreadContextMap()

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the context.
boolean	containsKey(java.lang.String key) Determines if the key is in the context.
static void	dispose()
java.lang.String	get(java.lang.String key) Gets the context identified by the key parameter.
java.util.Map<java.lang.String,java.lang.String>	getCopy() Gets a non-null mutable copy of current thread's context Map.
java.util.Map<java.lang.String,java.lang.String>	getImmutableMapOrNull() Returns an immutable view on the context Map or null if the context map is empty.
boolean	isEmpty() Returns true if the Map is empty.
void	put(java.lang.String key, java.lang.String value) Puts a context value (the o parameter) as identified with the key parameter into the current thread's context map.
void	remove(java.lang.String key) Removes 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

Log4jv2ThreadContextMap

public Log4jv2ThreadContextMap()

Method Detail

dispose

public static void dispose()

put

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

Description copied from interface: ThreadContextMap

Puts 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 java.lang.String get(java.lang.String key)

Description copied from interface: ThreadContextMap

Gets 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(java.lang.String key)

Description copied from interface: ThreadContextMap

Removes the the context identified by the key parameter.

Specified by:

remove in interface ThreadContextMap

Parameters:

key - The key to remove.

clear

public void clear()

Description copied from interface: ThreadContextMap

Clears the context.

Specified by:

clear in interface ThreadContextMap

containsKey

public boolean containsKey(java.lang.String key)

Description copied from interface: ThreadContextMap

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

getCopy

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

Description copied from interface: ThreadContextMap

Gets a non-null mutable copy of current thread's context Map.

Specified by:

getCopy in interface ThreadContextMap

Returns:

a mutable copy of the context.

getImmutableMapOrNull

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

Description copied from interface: ThreadContextMap

Returns an immutable view on the context Map or null if the context map is empty.

Specified by:

getImmutableMapOrNull in interface ThreadContextMap

Returns:

an immutable context Map or null.

isEmpty

public boolean isEmpty()

Description copied from interface: ThreadContextMap

Returns true if the Map is empty.

Specified by:

isEmpty in interface ThreadContextMap

Returns:

true if the Map is empty, false otherwise.