org.apache.commons.collections
Class SynchronizedPriorityQueue
java.lang.Object
org.apache.commons.collections.SynchronizedPriorityQueue
- All Implemented Interfaces:
- PriorityQueue
- public final class SynchronizedPriorityQueue
- extends java.lang.Object
- implements PriorityQueue
A thread safe version of the PriorityQueue. Provides synchronized wrapper methods for all the methods defined in the PriorityQueue interface.
- Since:
- 1.0
- Author:
| Method Summary |
void |
clear()
Clear all elements from queue. |
void |
insert(java.lang.Object element)
Insert an element into queue. |
boolean |
isEmpty()
Test if queue is empty. |
java.lang.Object |
peek()
Return element on top of heap but don't remove it. |
java.lang.Object |
pop()
Return element on top of heap and remove it. |
java.lang.String |
toString()
Returns a string representation of the underlying queue. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
m_priorityQueue
protected final PriorityQueue m_priorityQueue
-
The underlying priority queue.
SynchronizedPriorityQueue
public SynchronizedPriorityQueue(PriorityQueue priorityQueue)
-
Constructs a new synchronized priority queue.
- Parameters:
priorityQueue - the priority queue to synchronize
clear
public void clear()
-
Clear all elements from queue.
-
- Specified by:
clear in interface PriorityQueue
-
isEmpty
public boolean isEmpty()
-
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)
-
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
-
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
-
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()
-
Returns a string representation of the underlying queue.
-
-
- Returns:
- a string representation of the underlying queue
Please see keelframework.org for information about new Keel releases.