Class NoOpThreadContextMap

java.lang.Object
org.apache.logging.log4j.spi.NoOpThreadContextMap
All Implemented Interfaces:
ThreadContextMap

public class NoOpThreadContextMap extends Object implements ThreadContextMap
ThreadContextMap implementation used when either of system properties disableThreadContextMap or . disableThreadContext is true. This implementation does nothing.
Since:
2.7
  • Constructor Details

    • NoOpThreadContextMap

      public NoOpThreadContextMap()
  • Method Details

    • clear

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

      public boolean containsKey(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.
    • 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.
    • 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 ThreadContextMap
      Returns:
      true if the Map is empty, false otherwise.
    • 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.
    • 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.