org.apache.commons.collections

Class SynchronizedPriorityQueue

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.

Version:
$Revision: 1.13 $ $Date: 2004/02/18 01:15:42 $

Author:
Ram Chidambaram

Since:
Commons Collections 1.0

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.

Field Details

m_priorityQueue

protected final PriorityQueue m_priorityQueue
The underlying priority queue.

Constructor Details

SynchronizedPriorityQueue

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

Parameters:
priorityQueue - the priority queue to synchronize

Method Details

clear

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


insert

public void insert(Object element)
Insert an element into queue.
Specified by:
insert in interface PriorityQueue

Parameters:
element - the element to be inserted


isEmpty

public boolean isEmpty()
Test if queue is empty.
Specified by:
isEmpty in interface PriorityQueue

Returns:
true if queue is empty else false.


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


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


toString

public String toString()
Returns a string representation of the underlying queue.

Returns:
a string representation of the underlying queue


Copyright © 2001-2005 Apache Software Foundation. All Rights Reserved.