Package org.apache.logging.log4j.spi

Class DefaultThreadContextMap

java.lang.Object
org.apache.logging.log4j.spi.DefaultThreadContextMap
All Implemented Interfaces:
Serializable, ThreadContextMap, org.apache.logging.log4j.util.ReadOnlyStringMap
public class DefaultThreadContextMap extends Object implements ThreadContextMap, org.apache.logging.log4j.util.ReadOnlyStringMap
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.
See Also:

  • Field Details

    • INHERITABLE_MAP

      public static final String INHERITABLE_MAP
      Property name ("isThreadContextMapInheritable" ) for selecting InheritableThreadLocal (value "true") or plain ThreadLocal (value is not "true") in the implementation.
      See Also:

  • Constructor Details

    • DefaultThreadContextMap

      public DefaultThreadContextMap()

    • DefaultThreadContextMap

      public DefaultThreadContextMap(boolean useMap)

  • Method Details

    • put

      public void put(String key, 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.

    • putAll

      public void putAll(Map<String,String> m)

    • get

      public String get(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(String key)
      Description copied from interface: ThreadContextMap
      Removes the context identified by the key parameter.
      Specified by:
      remove in interface ThreadContextMap
      Parameters:
      key - The key to remove.

    • removeAll

      public void removeAll(Iterable<String> keys)

    • clear

      public void clear()
      Description copied from interface: ThreadContextMap
      Clears the context.
      Specified by:
      clear in interface ThreadContextMap

    • toMap

      public Map<String,String> toMap()
      Specified by:
      toMap in interface org.apache.logging.log4j.util.ReadOnlyStringMap

    • containsKey

      public boolean containsKey(String key)
      Description copied from interface: ThreadContextMap
      Determines if the key is in the context.
      Specified by:
      containsKey in interface org.apache.logging.log4j.util.ReadOnlyStringMap
      Specified by:
      containsKey in interface ThreadContextMap
      Parameters:
      key - The key to locate.
      Returns:
      True if the key is in the context, false otherwise.

    • forEach

      public <V> void forEach(org.apache.logging.log4j.util.BiConsumer<String,? super V> action)
      Specified by:
      forEach in interface org.apache.logging.log4j.util.ReadOnlyStringMap

    • forEach

      public <V, S> void forEach(org.apache.logging.log4j.util.TriConsumer<String,? super V,S> action, S state)
      Specified by:
      forEach in interface org.apache.logging.log4j.util.ReadOnlyStringMap

    • getValue

      public <V> V getValue(String key)
      Specified by:
      getValue in interface org.apache.logging.log4j.util.ReadOnlyStringMap

    • getCopy

      public Map<String,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 Map<String,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 org.apache.logging.log4j.util.ReadOnlyStringMap
      Specified by:
      isEmpty in interface ThreadContextMap
      Returns:
      true if the Map is empty, false otherwise.

    • size

      public int size()
      Specified by:
      size in interface org.apache.logging.log4j.util.ReadOnlyStringMap

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object