Package org.apache.pivot.collections.concurrent

Class SynchronizedStack<T>

  • All Implemented Interfaces:
    java.lang.Iterable<T>, Collection<T>, Stack<T>
    public class SynchronizedStack<T>
extends java.lang.Object
implements Stack<T>
    Synchronized implementation of the Stack interface.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Removes all elements from the collection.
      java.util.Comparator<T> getComparator()
      Returns the collection's sort order.
      int getDepth()  
      int getMaxDepth()  
      ListenerList<StackListener<T>> getStackListeners()  
      boolean isEmpty()
      Tests the emptiness of the stack.
      java.util.Iterator<T> iterator()
      NOTE Callers must manually synchronize on the SynchronizedStack instance to ensure thread safety during iteration.
      T peek()
      Returns the item on top of the stack without removing it from the stack.
      T pop()
      Removes the top item from the stack and returns it.
      void push​(T item)
      "Pushes" an item onto the stack.
      void setComparator​(java.util.Comparator<T> comparator)
      Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.
      void setMaxDepth​(int maxDepth)
      Set the maximum permitted stack/queue depth (0 = unlimited).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • SynchronizedStack

        public SynchronizedStack​(Stack<T> stack)

    • Method Detail

      • getMaxDepth

        public int getMaxDepth()
        Specified by:
        getMaxDepth in interface Stack<T>
        Returns:
        The maximum permitted stack/queue length (0 = unlimited).

      • setMaxDepth

        public void setMaxDepth​(int maxDepth)
        Description copied from interface: Stack
        Set the maximum permitted stack/queue depth (0 = unlimited).
        Specified by:
        setMaxDepth in interface Stack<T>
        Parameters:
        maxDepth - The new maximum depth.

      • push

        public void push​(T item)
        Description copied from interface: Stack
        "Pushes" an item onto the stack. If the stack is unsorted, the item is added at the top of the stack (getLength()). Otherwise, it is inserted at the appropriate index.

        If there is a maximum stack depth defined and the stack goes past this maximum depth, the deepest item (which could be this new item, depending on the comparator) will be removed.

        Specified by:
        push in interface Stack<T>
        Parameters:
        item - The item to push onto the stack.

      • pop

        public T pop()
        Description copied from interface: Stack
        Removes the top item from the stack and returns it.
        Specified by:
        pop in interface Stack<T>
        Returns:
        The top item from the stack (removed from it).

      • peek

        public T peek()
        Description copied from interface: Stack
        Returns the item on top of the stack without removing it from the stack. Returns null if the stack contains no items. Will also return null if the top item in the stack is null. getLength() can be used to distinguish between these two cases.
        Specified by:
        peek in interface Stack<T>
        Returns:
        The top item from the stack (which remains there).

      • clear

        public void clear()
        Description copied from interface: Collection
        Removes all elements from the collection.
        Specified by:
        clear in interface Collection<T>

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Stack
        Tests the emptiness of the stack.
        Specified by:
        isEmpty in interface Collection<T>
        Specified by:
        isEmpty in interface Stack<T>
        Returns:
        true if the stack contains no items; false, otherwise.

      • getDepth

        public int getDepth()
        Specified by:
        getDepth in interface Stack<T>
        Returns:
        The stack depth.

      • getComparator

        public java.util.Comparator<T> getComparator()
        Description copied from interface: Collection
        Returns the collection's sort order.
        Specified by:
        getComparator in interface Collection<T>
        Returns:
        The comparator used to order elements in the collection, or null if the sort order is undefined.
        See Also:
        Collection.setComparator(Comparator)

      • setComparator

        public void setComparator​(java.util.Comparator<T> comparator)
        Description copied from interface: Collection
        Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

        Calling this method more than once with the same comparator will re-sort the collection.

        Specified by:
        setComparator in interface Collection<T>
        Parameters:
        comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.

      • iterator

        public java.util.Iterator<T> iterator()
        NOTE Callers must manually synchronize on the SynchronizedStack instance to ensure thread safety during iteration.
        Specified by:
        iterator in interface java.lang.Iterable<T>