DefaultThreadContextMap (milky-thread 1.0.6

java.lang.Object
- cn.sliew.milky.thread.context.DefaultThreadContextMap

All Implemented Interfaces:

ThreadContextMap
```
public class DefaultThreadContextMap
extends Object
implements ThreadContextMap
```
The actual ThreadContext Map. A new ThreadContext Map is created each time it is updated and the Map stored is always immutable. This means the Map can be passed to other threads without concern that it will be updated. Since it is expected that the Map will be passed to many more log events than the number of keys it contains the performance should be much better than if the Map was copied for each event.

Constructor Summary

Constructors
Constructor and Description

DefaultThreadContextMap()

Constructors
Constructor and Description
`DefaultThreadContextMap()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the context.
`boolean`	`containsKey(String key)` Determines if the key is in the context.
`boolean`	`equals(Object obj)`
`String`	`get(String key)` Gets the context identified by the `key` parameter.
`Map<String,String>`	`getCopy()` Gets a non-`null` mutable copy of current thread's context Map.
`Map<String,String>`	`getImmutableMapOrNull()` Returns an immutable view on the context Map or `null` if the context map is empty.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if the Map is empty.
`ThreadContext.StoredContext`	`preserveContext()` preserve thread context map and set default context
`void`	`put(String key, String value)` Puts a context value (the `o` parameter) as identified with the `key` parameter into the current thread's context map.
`void`	`remove(String key)` Removes the context identified by the `key` parameter.
`ThreadContext.StoredContext`	`storeContext()` preserve thread context map without default context
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultThreadContextMap
```
public DefaultThreadContextMap()
```
- Method Detail
  - preserveContext
```
public ThreadContext.StoredContext preserveContext()
```
    Description copied from interface: ThreadContextMap
    
    preserve thread context map and set default context
    
    Specified by:
    
    preserveContext in interface ThreadContextMap
  - storeContext
```
public ThreadContext.StoredContext storeContext()
```
    Description copied from interface: ThreadContextMap
    
    preserve thread context map without default context
    
    Specified by:
    
    storeContext in interface ThreadContextMap
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class DefaultThreadContextMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultThreadContextMap

Method Detail

preserveContext

storeContext

put

get

remove

clear

containsKey

getCopy

getImmutableMapOrNull

isEmpty

toString

hashCode

equals