Package org.apache.logging.log4j

Interface ThreadContext.ContextStack

  • All Superinterfaces:
    java.util.Collection<java.lang.String>, java.lang.Iterable<java.lang.String>, java.io.Serializable
    All Known Subinterfaces:
    ThreadContextStack
    All Known Implementing Classes:
    DefaultThreadContextStack, MutableThreadContextStack
    Enclosing class:
    ThreadContext
    public static interface ThreadContext.ContextStack
extends java.io.Serializable, java.util.Collection<java.lang.String>
    The ThreadContext Stack interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> asList()
      Returns all the elements in the stack in a List.
      ThreadContext.ContextStack copy()
      Returns a copy of the ContextStack.
      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.
      java.lang.String peek()
      Returns the element at the top of the stack without removing it or null if the stack is empty.
      java.lang.String pop()
      Returns the element at the top of the stack.
      void push​(java.lang.String message)
      Pushes an element onto the stack.
      void trim​(int depth)
      Trims elements from the end of the stack.

      • Methods inherited from interface java.util.Collection

        add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

    • Method Detail

      • pop

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

      • peek

        java.lang.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​(java.lang.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

        java.util.List<java.lang.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.

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