MutableThreadContextStack

java.lang.Object
- org.apache.logging.log4j.spi.MutableThreadContextStack

All Implemented Interfaces:

Serializable, Iterable<String>, Collection<String>, ThreadContextStack, ThreadContext.ContextStack
```
public class MutableThreadContextStack
extends Object
implements ThreadContextStack
```
See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
`MutableThreadContextStack()` Constructs an empty MutableThreadContextStack.
`MutableThreadContextStack(List<String> list)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(String s)`
`boolean`	`addAll(Collection<? extends String> strings)`
`List<String>`	`asList()` Returns all the elements in the stack in a List.
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> objects)`
`ThreadContextStack`	`copy()` Returns a copy of the ContextStack.
`boolean`	`equals(Object obj)`
`void`	`freeze()` "Freezes" this context stack so it becomes immutable: all mutator methods will throw an exception from now on.
`int`	`getDepth()` Returns the number of elements in the stack.
`ThreadContext.ContextStack`	`getImmutableStackOrNull()` Returns a ContextStack with the same contents as this ContextStack or `null`.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isFrozen()`
`Iterator<String>`	`iterator()`
`String`	`peek()` Returns the element at the top of the stack without removing it or null if the stack is empty.
`String`	`pop()` Returns the element at the top of the stack.
`void`	`push(String message)` Pushes an element onto the stack.
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> objects)`
`boolean`	`retainAll(Collection<?> objects)`
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] ts)`
`String`	`toString()`
`void`	`trim(int depth)` Trims elements from the end of the stack.

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

Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - MutableThreadContextStack
```
public MutableThreadContextStack()
```
    Constructs an empty MutableThreadContextStack.
  - MutableThreadContextStack
```
public MutableThreadContextStack(List<String> list)
```
- Method Detail
  - pop
```
public String pop()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns the element at the top of the stack.
    
    Specified by:
    
    pop in interface ThreadContext.ContextStack
    
    Returns:
    
    The element at the top of the stack.
  - peek
```
public String peek()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns the element at the top of the stack without removing it or null if the stack is empty.
    
    Specified by:
    
    peek in interface ThreadContext.ContextStack
    
    Returns:
    
    the element at the top of the stack or null if the stack is empty.
  - push
```
public void push(String message)
```
    Description copied from interface: ThreadContext.ContextStack
    
    Pushes an element onto the stack.
    
    Specified by:
    
    push in interface ThreadContext.ContextStack
    
    Parameters:
    
    message - The element to add.
  - getDepth
```
public int getDepth()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns the number of elements in the stack.
    
    Specified by:
    
    getDepth in interface ThreadContext.ContextStack
    
    Returns:
    
    the number of elements in the stack.
  - asList
```
public List<String> asList()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns all the elements in the stack in a List.
    
    Specified by:
    
    asList in interface ThreadContext.ContextStack
    
    Returns:
    
    all the elements in the stack in a List.
  - trim
```
public void trim(int depth)
```
    Description copied from interface: ThreadContext.ContextStack
    
    Trims elements from the end of the stack.
    
    Specified by:
    
    trim in interface ThreadContext.ContextStack
    
    Parameters:
    
    depth - The maximum number of items in the stack to keep.
  - copy
```
public ThreadContextStack copy()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns a copy of the ContextStack.
    
    Specified by:
    
    copy in interface ThreadContext.ContextStack
    
    Returns:
    
    a copy of the ContextStack.
  - clear
```
public void clear()
```
  - size
```
public int size()
```
  - isEmpty
```
public boolean isEmpty()
```
  - contains
```
public boolean contains(Object o)
```
  - iterator
```
public Iterator<String> iterator()
```
  - toArray
```
public Object[] toArray()
```
  - toArray
```
public <T> T[] toArray(T[] ts)
```
  - add
```
public boolean add(String s)
```
  - remove
```
public boolean remove(Object o)
```
  - containsAll
```
public boolean containsAll(Collection<?> objects)
```
  - addAll
```
public boolean addAll(Collection<? extends String> strings)
```
  - removeAll
```
public boolean removeAll(Collection<?> objects)
```
  - retainAll
```
public boolean retainAll(Collection<?> objects)
```
  - toString
```
public String toString()
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(Object obj)
```
  - getImmutableStackOrNull
```
public ThreadContext.ContextStack getImmutableStackOrNull()
```
    Description copied from interface: ThreadContext.ContextStack
    
    Returns a ContextStack with the same contents as this ContextStack or null. Attempts to modify the returned stack may or may not throw an exception, but will not affect the contents of this ContextStack.
    
    Specified by:
    
    getImmutableStackOrNull in interface ThreadContext.ContextStack
    
    Returns:
    
    a ContextStack with the same contents as this ContextStack or null.
  - freeze
```
public void freeze()
```
    "Freezes" this context stack so it becomes immutable: all mutator methods will throw an exception from now on.
  - isFrozen
```
public boolean isFrozen()
```

Class MutableThreadContextStack

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

MutableThreadContextStack

MutableThreadContextStack

Method Detail

pop

peek

push

getDepth

asList

trim

copy

clear

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

removeAll

retainAll

toString

hashCode

equals

getImmutableStackOrNull

freeze

isFrozen