Package org.slf4j.helpers

Class NOPMDCAdapter

java.lang.Object
org.slf4j.helpers.NOPMDCAdapter
All Implemented Interfaces:
MDCAdapter
public class NOPMDCAdapter extends Object implements MDCAdapter
This adapter is an empty implementation of the MDCAdapter interface. It is used for all logging systems which do not support mapped diagnostic contexts such as JDK14, simple and NOP.
Since:
1.4.1
Author:
Ceki Gülcü

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MDCAdapter
      Clear all entries in the MDC.
      Specified by:
      clear in interface MDCAdapter

    • get

      public String get(String key)
      Description copied from interface: MDCAdapter
      Get the context identified by the key parameter. The key parameter cannot be null.
      Specified by:
      get in interface MDCAdapter
      Returns:
      the string value identified by the key parameter.

    • put

      public void put(String key, String val)
      Description copied from interface: MDCAdapter
      Put a context value (the val parameter) as identified with the key parameter into the current thread's context map. The key parameter cannot be null. The val parameter can be null only if the underlying implementation supports it.

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

      Specified by:
      put in interface MDCAdapter

    • remove

      public void remove(String key)
      Description copied from interface: MDCAdapter
      Remove the context identified by the key parameter. The key parameter cannot be null.

      This method does nothing if there is no previous value associated with key.

      Specified by:
      remove in interface MDCAdapter

    • getCopyOfContextMap

      public Map<String,String> getCopyOfContextMap()
      Description copied from interface: MDCAdapter
      Return a copy of the current thread's context map, with keys and values of type String. Returned value may be null.
      Specified by:
      getCopyOfContextMap in interface MDCAdapter
      Returns:
      A copy of the current thread's context map. May be null.

    • setContextMap

      public void setContextMap(Map<String,String> contextMap)
      Description copied from interface: MDCAdapter
      Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter. The context map parameter must only contain keys and values of type String. Implementations must support null valued map passed as parameter.
      Specified by:
      setContextMap in interface MDCAdapter
      Parameters:
      contextMap - must contain only keys and values of type String

    • pushByKey

      public void pushByKey(String key, String value)
      Description copied from interface: MDCAdapter
      Push a value into the deque(stack) referenced by 'key'.
      Specified by:
      pushByKey in interface MDCAdapter
      Parameters:
      key - identifies the appropriate stack
      value - the value to push into the stack

    • popByKey

      public String popByKey(String key)
      Description copied from interface: MDCAdapter
      Pop the stack referenced by 'key' and return the value possibly null.
      Specified by:
      popByKey in interface MDCAdapter
      Parameters:
      key - identifies the deque(stack)
      Returns:
      the value just popped. May be null/

    • getCopyOfDequeByKey

      public Deque<String> getCopyOfDequeByKey(String key)
      Description copied from interface: MDCAdapter
      Returns a copy of the deque(stack) referenced by 'key'. May be null.
      Specified by:
      getCopyOfDequeByKey in interface MDCAdapter
      Parameters:
      key - identifies the stack
      Returns:
      copy of stack referenced by 'key'. May be null.

    • clearDequeByKey

      public void clearDequeByKey(String key)
      Description copied from interface: MDCAdapter
      Clear the deque(stack) referenced by 'key'.
      Specified by:
      clearDequeByKey in interface MDCAdapter
      Parameters:
      key - identifies the stack