The head of this queue is the least element with respect to the specified ordering. If multiple elements are tied for least value, the head is one of those elements -- ties are broken arbitrarily. The queue retrieval operations poll, remove, peek, and element access the element at the head of the queue.
A priority queue is unbounded, but has an internal capacity governing the size of an array used to store the elements on the queue. It is always at least as large as the queue size. As elements are added to a priority queue, its capacity grows automatically. The details of the growth policy are not specified.
This class and its iterator implement all of the optional methods of the Collection and Iterator interfaces. The Iterator provided in method iterator() is not guaranteed to traverse the elements of the priority queue in any particular order. If you need ordered traversal, consider using Arrays.sort(pq.toArray()).
Note that this implementation is not synchronized. Multiple threads should not access a PriorityQueue instance concurrently if any of the threads modifies the queue. Instead, use the thread-safe java.util.concurrent.PriorityBlockingQueue class.
Implementation note: this implementation provides O(log(n)) time for the enqueing and dequeing methods (offer, poll, remove() and add); linear time for the remove(Object) and contains(Object) methods; and constant time for the retrieval methods (peek, element, and size).
This class is a member of the Java Collections Framework.
| Constructor Summary | ||
| PriorityQueue() Creates a PriorityQueue with the default initial
capacity (11) that orders its elements according to their
natural ordering. |
||
| PriorityQueue(int initialCapacity) Creates a PriorityQueue with the specified initial
capacity that orders its elements according to their
natural ordering. |
||
| PriorityQueue(int initialCapacity, Comparator<? super E> comparator) Creates a PriorityQueue with the specified initial capacity
that orders its elements according to the specified comparator. |
||
| PriorityQueue(Collection<? extends E> c) Creates a PriorityQueue containing the elements in the
specified collection. |
||
| PriorityQueue(PriorityQueue<? extends E> c) Creates a PriorityQueue containing the elements in the
specified priority queue. |
||
| PriorityQueue(SortedSet<? extends E> c) Creates a PriorityQueue containing the elements in the
specified sorted set. |
| Method Summary | ||
boolean |
add(E e) Inserts the specified element into this priority queue. |
|
void |
clear() Removes all of the elements from this priority queue. |
|
Comparator<? super E> |
comparator() Returns the comparator used to order the elements in this
queue, or null if this queue is sorted according to
the natural ordering of its elements. |
|
boolean |
contains(Object o) Returns true if this queue contains the specified element. |
|
| iterator() Returns an iterator over the elements in this queue. |
||
boolean |
offer(E e) Inserts the specified element into this priority queue. |
|
| peek() Retrieves, but does not remove, the head of this queue,
or returns null if this queue is empty. |
||
| poll() Retrieves and removes the head of this queue,
or returns null if this queue is empty. |
||
boolean |
remove(Object o) Removes a single instance of the specified element from this queue,
if it is present. |
|
int |
size() Returns the number of elements in this collection. |
|
Object[] |
toArray() Returns an array containing all of the elements in this queue. |
|
T[] |
toArray(T[] a) Returns an array containing all of the elements in this queue; the
runtime type of the returned array is that of the specified array. |
|
| Methods inherited from class java.util.AbstractQueue |
| addAll, element, remove |
| Methods inherited from class java.util.AbstractCollection |
| containsAll, isEmpty, removeAll, retainAll, toString |
| Methods inherited from class java.lang.Object |
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.Collection |
| equals, hashCode |
The returned array will be "safe" in that no references to it are maintained by this queue. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based APIs.
If the queue fits in the specified array with room to spare (i.e., the array has more elements than the queue), the element in the array immediately following the end of the collection is set to null.
Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.
Suppose x is a queue known to contain only strings. The following code can be used to dump the queue into a newly allocated array of String:
String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to
toArray().