Package org.apache.commons.collections

Class SynchronizedPriorityQueue

  • All Implemented Interfaces:
    PriorityQueue
    @Deprecated(since="2021-04-30")
public final class SynchronizedPriorityQueue
extends java.lang.Object
implements PriorityQueue
    Deprecated.
    PriorityQueue is replaced by the Buffer interface, see buffer subpackage. Due to be removed in v4.0.
    A thread safe version of the PriorityQueue. Provides synchronized wrapper methods for all the methods defined in the PriorityQueue interface.
    Since:
    Commons Collections 1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void clear()
      Deprecated.
      Clear all elements from queue.
      void insert​(java.lang.Object element)
      Deprecated.
      Insert an element into queue.
      boolean isEmpty()
      Deprecated.
      Test if queue is empty.
      java.lang.Object peek()
      Deprecated.
      Return element on top of heap but don't remove it.
      java.lang.Object pop()
      Deprecated.
      Return element on top of heap and remove it.
      java.lang.String toString()
      Deprecated.
      Returns a string representation of the underlying queue.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SynchronizedPriorityQueue

        public SynchronizedPriorityQueue​(PriorityQueue priorityQueue)
        Deprecated.
        Constructs a new synchronized priority queue.
        Parameters:
        priorityQueue - the priority queue to synchronize

    • Method Detail

      • clear

        public void clear()
        Deprecated.
        Clear all elements from queue.
        Specified by:
        clear in interface PriorityQueue

      • isEmpty

        public boolean isEmpty()
        Deprecated.
        Test if queue is empty.
        Specified by:
        isEmpty in interface PriorityQueue
        Returns:
        true if queue is empty else false.

      • insert

        public void insert​(java.lang.Object element)
        Deprecated.
        Insert an element into queue.
        Specified by:
        insert in interface PriorityQueue
        Parameters:
        element - the element to be inserted

      • peek

        public java.lang.Object peek()
                      throws java.util.NoSuchElementException
        Deprecated.
        Return element on top of heap but don't remove it.
        Specified by:
        peek in interface PriorityQueue
        Returns:
        the element at top of heap
        Throws:
        java.util.NoSuchElementException - if isEmpty() == true

      • pop

        public java.lang.Object pop()
                     throws java.util.NoSuchElementException
        Deprecated.
        Return element on top of heap and remove it.
        Specified by:
        pop in interface PriorityQueue
        Returns:
        the element at top of heap
        Throws:
        java.util.NoSuchElementException - if isEmpty() == true

      • toString

        public java.lang.String toString()
        Deprecated.
        Returns a string representation of the underlying queue.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the underlying queue