org.apache.commons.collections
Class SynchronizedPriorityQueue

java.lang.Object
  |
  +--org.apache.commons.collections.SynchronizedPriorityQueue

public final class SynchronizedPriorityQueue

extends 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:

Ram Chidambaram

Field Summary

protected PriorityQueue

m_priorityQueue The underlying priority queue.

Constructor Summary

SynchronizedPriorityQueue(PriorityQueue priorityQueue)
Constructs a new synchronized priority queue.

Method Summary

void	clear() Clear all elements from queue.
void	insert(Object element) Insert an element into queue.
boolean	isEmpty() Test if queue is empty.
Object	peek() Return element on top of heap but don't remove it.
Object	pop() Return element on top of heap and remove it.
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

Field Detail

m_priorityQueue

protected final PriorityQueue m_priorityQueue

The underlying priority queue.

Constructor Detail

SynchronizedPriorityQueue

public SynchronizedPriorityQueue(PriorityQueue priorityQueue)

Constructs a new synchronized priority queue.

Parameters:

priorityQueue - the priority queue to synchronize

Method Detail

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(Object element)

Insert an element into queue.

Specified by:

insert in interface PriorityQueue

Parameters:

element - the element to be inserted

peek

public Object peek()
            throws 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:

NoSuchElementException - if isEmpty() == true

pop

public Object pop()
           throws NoSuchElementException

Return element on top of heap and remove it.

Specified by:

pop in interface PriorityQueue

Returns:

the element at top of heap

Throws:

NoSuchElementException - if isEmpty() == true

toString

public String toString()

Returns a string representation of the underlying queue.

Overrides:

toString in class Object

Returns:

a string representation of the underlying queue