Interface ThreadContext.ContextStack

All Superinterfaces:
Collection<String>, Iterable<String>, Serializable
All Known Subinterfaces:
ThreadContextStack
All Known Implementing Classes:
DefaultThreadContextStack, MutableThreadContextStack
Enclosing class:
ThreadContext

public static interface ThreadContext.ContextStack extends Serializable, Collection<String>
The ThreadContext Stack interface.
  • Method Details

    • pop

      String pop()
      Returns the element at the top of the stack.
      Returns:
      The element at the top of the stack.
      Throws:
      NoSuchElementException - if the stack is empty.
    • peek

      String peek()
      Returns the element at the top of the stack without removing it or null if the stack is empty.
      Returns:
      the element at the top of the stack or null if the stack is empty.
    • push

      void push(String message)
      Pushes an element onto the stack.
      Parameters:
      message - The element to add.
    • getDepth

      int getDepth()
      Returns the number of elements in the stack.
      Returns:
      the number of elements in the stack.
    • asList

      List<String> asList()
      Returns all the elements in the stack in a List.
      Returns:
      all the elements in the stack in a List.
    • trim

      void trim(int depth)
      Trims elements from the end of the stack.
      Parameters:
      depth - The maximum number of items in the stack to keep.
    • copy

      Returns a copy of the ContextStack.
      Returns:
      a copy of the ContextStack.
    • getImmutableStackOrNull

      ThreadContext.ContextStack getImmutableStackOrNull()
      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.
      Returns:
      a ContextStack with the same contents as this ContextStack or null.