SLF4J API Module 2.0.17 · org.slf4j.spi.MDCAdapter · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	clear() Clear all entries in the MDC.
public void	clearDequeByKey(String identifies the stack key) Clear the deque(stack) referenced by 'key'.
public String	Returns: the string value identified by the `key` parameter. get(String key) Get the context identified by the `key` parameter.
public Map<String, String>	Returns: A copy of the current thread's context map. May be null. getCopyOfContextMap() Return a copy of the current thread's context map, with keys and values of type String.
public Deque<String>	Returns: copy of stack referenced by 'key'. May be null. getCopyOfDequeByKey(String identifies the stack key) Returns a copy of the deque(stack) referenced by 'key'.
public String	Returns: the value just popped. May be null/ popByKey(String identifies the deque(stack) key) Pop the stack referenced by 'key' and return the value possibly null.
public void	pushByKey(String identifies the appropriate stack key, String the value to push into the stack value) Push a value into the deque(stack) referenced by 'key'.
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.
public void	remove(String key) Remove the context identified by the `key` parameter.
public void	setContextMap(Map<String, String> must contain only keys and values of type String contextMap) Set the current thread's context map by first clearing any existing map and then copying the map passed as parameter.

Method Detail

clear	back to summary
public void clear() Clear all entries in the MDC.

clearDequeByKey	back to summary
public void clearDequeByKey(String key) Clear the deque(stack) referenced by 'key'. Parameters key:String identifies the stack Since 2.0.0

clearDequeByKey

back to summary

public void clearDequeByKey(String key)

Clear the deque(stack) referenced by 'key'.

Parameters

key:String: identifies the stack

Since

2.0.0

get back to summary

get	back to summary
public String get(String key) Get the context identified by the `key` parameter. The `key` parameter cannot be null. Returns:String the string value identified by the `key` parameter.

public String get(String key)

Get the context identified by the key parameter. The key parameter cannot be null.

Returns:String: the string value identified by the key parameter.

getCopyOfContextMap	back to summary
public Map<String, String> getCopyOfContextMap() Return a copy of the current thread's context map, with keys and values of type String. Returned value may be null. Returns:Map<String, String> A copy of the current thread's context map. May be null. Since 1.5.1

getCopyOfContextMap

back to summary

public Map<String, String> getCopyOfContextMap()

Return a copy of the current thread's context map, with keys and values of type String. Returned value may be null.

Returns:Map<String, String>: A copy of the current thread's context map. May be null.
Since: 1.5.1

getCopyOfDequeByKey	back to summary
public Deque<String> getCopyOfDequeByKey(String key) Returns a copy of the deque(stack) referenced by 'key'. May be null. Parameters key:String identifies the stack Returns:Deque<String> copy of stack referenced by 'key'. May be null. Since 2.0.0

getCopyOfDequeByKey

back to summary

public Deque<String> getCopyOfDequeByKey(String key)

Returns a copy of the deque(stack) referenced by 'key'. May be null.

Parameters

key:String: identifies the stack

Returns:Deque<String>

copy of stack referenced by 'key'. May be null.

Since

2.0.0

popByKey	back to summary
public String popByKey(String key) Pop the stack referenced by 'key' and return the value possibly null. Parameters key:String identifies the deque(stack) Returns:String the value just popped. May be null/ Since 2.0.0

popByKey

back to summary

public String popByKey(String key)

Pop the stack referenced by 'key' and return the value possibly null.

Parameters

key:String: identifies the deque(stack)

Returns:String

the value just popped. May be null/

Since

2.0.0

pushByKey	back to summary
public void pushByKey(String key, String value) Push a value into the deque(stack) referenced by 'key'. Parameters key:String identifies the appropriate stack value:String the value to push into the stack Since 2.0.0

pushByKey

back to summary

public void pushByKey(String key, String value)

Push a value into the deque(stack) referenced by 'key'.

Parameters

key:String: identifies the appropriate stack
value:String: the value to push into the stack

Since

2.0.0

put back to summary

put	back to summary
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. 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.

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. 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.

remove back to summary

remove	back to summary
public void remove(String key) 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`.

public void remove(String key)

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.

setContextMap	back to summary
public void setContextMap(Map<String, String> contextMap) 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. Parameters contextMap:Map<String, String> must contain only keys and values of type String Since 1.5.1

setContextMap

back to summary

public void setContextMap(Map<String, String> contextMap)

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.

Parameters

contextMap:Map<String, String>: must contain only keys and values of type String

Since

1.5.1

public Interface MDCAdapter

Method Summary

Method Detail