Package org.slf4j.helpers

Class NOPMDCAdapter

  • All Implemented Interfaces:
    MDCAdapter
    public class NOPMDCAdapter
extends java.lang.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 Summary

      Constructors 
      Constructor Description
      NOPMDCAdapter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Clear all entries in the MDC.
      void clearDequeByKey​(java.lang.String key)
      Clear the deque(stack) referenced by 'key'.
      java.lang.String get​(java.lang.String key)
      Get the context identified by the key parameter.
      java.util.Map<java.lang.String,​java.lang.String> getCopyOfContextMap()
      Return a copy of the current thread's context map, with keys and values of type String.
      java.util.Deque<java.lang.String> getCopyOfDequeByKey​(java.lang.String key)
      Returns a copy of the deque(stack) referenced by 'key'.
      java.lang.String popByKey​(java.lang.String key)
      Pop the stack referenced by 'key' and return the value possibly null.
      void pushByKey​(java.lang.String key, java.lang.String value)
      Push a value into the deque(stack) referenced by 'key'.
      void put​(java.lang.String key, java.lang.String val)
      Put a context value (the val parameter) as identified with the key parameter into the current thread's context map.
      void remove​(java.lang.String key)
      Remove the context identified by the key parameter.
      void setContextMap​(java.util.Map<java.lang.String,​java.lang.String> contextMap)
      Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • clear

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

      • get

        public java.lang.String get​(java.lang.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​(java.lang.String key,
                java.lang.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​(java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.String key,
                      java.lang.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 java.lang.String popByKey​(java.lang.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 java.util.Deque<java.lang.String> getCopyOfDequeByKey​(java.lang.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​(java.lang.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