Log4jMDCAdapter (SLF4J 1.7.28 API)
Date: 2019-08-10

org.slf4j.impl

## Class Log4jMDCAdapter

- java.lang.Object
- - org.slf4j.impl.Log4jMDCAdapter

- All Implemented Interfaces:
    MDCAdapter

      public class Log4jMDCAdapter
      extends Object
      implements MDCAdapter

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Log4jMDCAdapter()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `clear()` Clear all entries in the MDC.
    `String` | `get(String key)` Get the context identified by the `key` parameter.
    `Map` | `getCopyOfContextMap()` Return a copy of the current thread's context map, with keys and values of type String.
    `void` | `put(String key, String val)` Put a context value (the `val` parameter) as identified with the `key` parameter into the current thread's context map.
    `void` | `remove(String key)` Remove the the context identified by the `key` parameter.
    `void` | `setContextMap(Map 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`

- - ### Constructor Detail

    - #### Log4jMDCAdapter

          public Log4jMDCAdapter()

  - ### 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 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)

      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. Log4j does not support null for the `val` parameter.

      This method delegates all work to log4j's MDC.

      Specified by:
        `put` in interface `MDCAdapter`
      Throws:
        `IllegalArgumentException` - in case the "key" or "val" parameter is null

    - #### remove

          public void remove(String key)

      Description copied from interface: `MDCAdapter`
      Remove the 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 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 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.
      Specified by:
        `setContextMap` in interface `MDCAdapter`
      Parameters:
        `contextMap` - must contain only keys and values of type String

Copyright © 2005–2019 QOS.ch. All rights reserved.