| public class java.util.concurrent PriorityBlockingQueue<E>
|
Java SE 6 |
PriorityQueue and supplies
blocking retrieval operations. While this queue is logically
unbounded, attempted additions may fail due to resource exhaustion
(causing OutOfMemoryError). This class does not permit
null elements. A priority queue relying on natural ordering also does not permit insertion of
non-comparable objects (doing so results in
ClassCastException).
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 PriorityBlockingQueue in any particular order. If you need
ordered traversal, consider using
Arrays.sort(pq.toArray()). Also, method drainTo
can be used to remove some or all elements in priority
order and place them in another collection.
Operations on this class make no guarantees about the ordering of elements with equal priority. If you need to enforce an ordering, you can define custom classes or comparators that use a secondary key to break ties in primary priority values. For example, here is a class that applies first-in-first-out tie-breaking to comparable elements. To use it, you would insert a new FIFOEntry(anEntry) instead of a plain entry object.
class FIFOEntry<E extends Comparable<? super E>>
implements Comparable<FIFOEntry<E>> {
final static AtomicLong seq = new AtomicLong();
final long seqNum;
final E entry;
public FIFOEntry(E entry) {
seqNum = seq.getAndIncrement();
this.entry = entry;
}
public E getEntry() { return entry; }
public int compareTo(FIFOEntry<E> other) {
int res = entry.compareTo(other.entry);
if (res == 0 && other.entry != this.entry)
res = (seqNum < other.seqNum ? -1 : 1);
return res;
}
}
This class is a member of the Java Collections Framework.
| since | 1.5 |
| E | the type of elements held in this collection |
| Constructors | |||||||
|---|---|---|---|---|---|---|---|
| public | PriorityBlockingQueue() Creates a PriorityBlockingQueue with the default initial capacity (11) that orders its elements according to their natural ordering. | ||||||
| public | PriorityBlockingQueue(int initialCapacity) Creates a PriorityBlockingQueue with the specified initial capacity that orders its elements according to their natural ordering.
| ||||||
| public | PriorityBlockingQueue(int initialCapacity, Comparator comparator) Creates a PriorityBlockingQueue with the specified initial capacity that orders its elements according to the specified comparator.
| ||||||
| public | PriorityBlockingQueue(Collection c) Creates a PriorityBlockingQueue containing the elements in the specified collection. If the specified collection is a SortedSet or a PriorityQueue, this
priority queue will be ordered according to the same ordering.
Otherwise, this priority queue will be ordered according to the
natural ordering of its elements.
| ||||||
| Methods | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | add(Object e) Inserts the specified element into this priority queue.
| ||||||||||||
| public void | clear() Atomically removes all of the elements from this queue. The queue will be empty after this call returns. | ||||||||||||
| public Comparator | comparator() Returns the comparator used to order the elements in this queue, or null if this queue uses the natural ordering of its elements.
| ||||||||||||
| public boolean | contains(Object o) Returns true if this queue contains the specified element.
More formally, returns true if and only if this queue contains
at least one element e such that o.equals(e).
| ||||||||||||
| public int | drainTo(Collection c)
| ||||||||||||
| public int | drainTo(Collection c, int maxElements)
| ||||||||||||
| public Iterator | iterator() Returns an iterator over the elements in this queue. The iterator does not return the elements in any particular order. The returned Iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse
elements as they existed upon construction of the iterator, and
may (but is not guaranteed to) reflect any modifications
subsequent to construction.
| ||||||||||||
| public boolean | offer(Object e) Inserts the specified element into this priority queue.
| ||||||||||||
| public boolean | offer(Object e, long timeout, TimeUnit unit) Inserts the specified element into this priority queue. As the queue is unbounded this method will never block.
| ||||||||||||
| public Object | peek() | ||||||||||||
| public Object | poll() | ||||||||||||
| public Object | poll(long timeout, TimeUnit unit) throws InterruptedException | ||||||||||||
| public void | put(Object e) Inserts the specified element into this priority queue. As the queue is unbounded this method will never block.
| ||||||||||||
| public int | remainingCapacity() Always returns Integer.MAX_VALUE because a PriorityBlockingQueue is not capacity constrained.
| ||||||||||||
| public boolean | remove(Object o) Removes a single instance of the specified element from this queue, if it is present. More formally, removes an element e such
that o.equals(e), if this queue contains one or more such
elements. Returns true if and only if this queue contained
the specified element (or equivalently, if this queue changed as a
result of the call).
| ||||||||||||
| public int | size() | ||||||||||||
| public Object | take() throws InterruptedException | ||||||||||||
| public Object[] | toArray() Returns an array containing all of the elements in this queue. The returned array elements are in no particular order. 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.
| ||||||||||||
| public Object[]<T> | toArray(Object[] 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. The returned array elements are in no particular order. If the queue fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this queue. If this queue fits in the specified array with room to spare (i.e., the array has more elements than this queue), the element in the array immediately following the end of the queue is set to null. Like the 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().
| ||||||||||||
| public String | toString() | ||||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|