1 |
dl |
1.2 |
/* |
2 |
|
|
* Written by Doug Lea with assistance from members of JCP JSR-166 |
3 |
dl |
1.33 |
* Expert Group and released to the public domain, as explained at |
4 |
jsr166 |
1.71 |
* http://creativecommons.org/publicdomain/zero/1.0/ |
5 |
dl |
1.2 |
*/ |
6 |
|
|
|
7 |
tim |
1.1 |
package java.util.concurrent; |
8 |
tim |
1.13 |
|
9 |
dl |
1.115 |
import java.lang.invoke.MethodHandles; |
10 |
|
|
import java.lang.invoke.VarHandle; |
11 |
dl |
1.86 |
import java.util.AbstractQueue; |
12 |
|
|
import java.util.Arrays; |
13 |
|
|
import java.util.Collection; |
14 |
|
|
import java.util.Comparator; |
15 |
|
|
import java.util.Iterator; |
16 |
|
|
import java.util.NoSuchElementException; |
17 |
|
|
import java.util.PriorityQueue; |
18 |
|
|
import java.util.Queue; |
19 |
|
|
import java.util.SortedSet; |
20 |
|
|
import java.util.Spliterator; |
21 |
jsr166 |
1.105 |
import java.util.concurrent.locks.Condition; |
22 |
|
|
import java.util.concurrent.locks.ReentrantLock; |
23 |
|
|
import java.util.function.Consumer; |
24 |
tim |
1.1 |
|
25 |
|
|
/** |
26 |
dl |
1.25 |
* An unbounded {@linkplain BlockingQueue blocking queue} that uses |
27 |
|
|
* the same ordering rules as class {@link PriorityQueue} and supplies |
28 |
|
|
* blocking retrieval operations. While this queue is logically |
29 |
dl |
1.24 |
* unbounded, attempted additions may fail due to resource exhaustion |
30 |
jsr166 |
1.63 |
* (causing {@code OutOfMemoryError}). This class does not permit |
31 |
|
|
* {@code null} elements. A priority queue relying on {@linkplain |
32 |
jsr166 |
1.42 |
* Comparable natural ordering} also does not permit insertion of |
33 |
|
|
* non-comparable objects (doing so results in |
34 |
jsr166 |
1.63 |
* {@code ClassCastException}). |
35 |
dl |
1.20 |
* |
36 |
dl |
1.38 |
* <p>This class and its iterator implement all of the |
37 |
|
|
* <em>optional</em> methods of the {@link Collection} and {@link |
38 |
dl |
1.41 |
* Iterator} interfaces. The Iterator provided in method {@link |
39 |
|
|
* #iterator()} is <em>not</em> guaranteed to traverse the elements of |
40 |
|
|
* the PriorityBlockingQueue in any particular order. If you need |
41 |
|
|
* ordered traversal, consider using |
42 |
jsr166 |
1.63 |
* {@code Arrays.sort(pq.toArray())}. Also, method {@code drainTo} |
43 |
dl |
1.41 |
* can be used to <em>remove</em> some or all elements in priority |
44 |
|
|
* order and place them in another collection. |
45 |
|
|
* |
46 |
|
|
* <p>Operations on this class make no guarantees about the ordering |
47 |
|
|
* of elements with equal priority. If you need to enforce an |
48 |
|
|
* ordering, you can define custom classes or comparators that use a |
49 |
|
|
* secondary key to break ties in primary priority values. For |
50 |
|
|
* example, here is a class that applies first-in-first-out |
51 |
|
|
* tie-breaking to comparable elements. To use it, you would insert a |
52 |
jsr166 |
1.63 |
* {@code new FIFOEntry(anEntry)} instead of a plain entry object. |
53 |
dl |
1.41 |
* |
54 |
jsr166 |
1.109 |
* <pre> {@code |
55 |
jsr166 |
1.56 |
* class FIFOEntry<E extends Comparable<? super E>> |
56 |
|
|
* implements Comparable<FIFOEntry<E>> { |
57 |
jsr166 |
1.58 |
* static final AtomicLong seq = new AtomicLong(0); |
58 |
dl |
1.41 |
* final long seqNum; |
59 |
|
|
* final E entry; |
60 |
|
|
* public FIFOEntry(E entry) { |
61 |
|
|
* seqNum = seq.getAndIncrement(); |
62 |
|
|
* this.entry = entry; |
63 |
|
|
* } |
64 |
|
|
* public E getEntry() { return entry; } |
65 |
jsr166 |
1.56 |
* public int compareTo(FIFOEntry<E> other) { |
66 |
dl |
1.41 |
* int res = entry.compareTo(other.entry); |
67 |
jsr166 |
1.56 |
* if (res == 0 && other.entry != this.entry) |
68 |
|
|
* res = (seqNum < other.seqNum ? -1 : 1); |
69 |
dl |
1.41 |
* return res; |
70 |
|
|
* } |
71 |
jsr166 |
1.56 |
* }}</pre> |
72 |
dl |
1.20 |
* |
73 |
dl |
1.35 |
* <p>This class is a member of the |
74 |
jsr166 |
1.53 |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
75 |
dl |
1.35 |
* Java Collections Framework</a>. |
76 |
|
|
* |
77 |
dl |
1.6 |
* @since 1.5 |
78 |
|
|
* @author Doug Lea |
79 |
jsr166 |
1.104 |
* @param <E> the type of elements held in this queue |
80 |
dl |
1.28 |
*/ |
81 |
jsr166 |
1.82 |
@SuppressWarnings("unchecked") |
82 |
dl |
1.5 |
public class PriorityBlockingQueue<E> extends AbstractQueue<E> |
83 |
dl |
1.15 |
implements BlockingQueue<E>, java.io.Serializable { |
84 |
dl |
1.21 |
private static final long serialVersionUID = 5595510919245408276L; |
85 |
tim |
1.1 |
|
86 |
dl |
1.59 |
/* |
87 |
dl |
1.66 |
* The implementation uses an array-based binary heap, with public |
88 |
|
|
* operations protected with a single lock. However, allocation |
89 |
|
|
* during resizing uses a simple spinlock (used only while not |
90 |
|
|
* holding main lock) in order to allow takes to operate |
91 |
|
|
* concurrently with allocation. This avoids repeated |
92 |
|
|
* postponement of waiting consumers and consequent element |
93 |
|
|
* build-up. The need to back away from lock during allocation |
94 |
|
|
* makes it impossible to simply wrap delegated |
95 |
|
|
* java.util.PriorityQueue operations within a lock, as was done |
96 |
|
|
* in a previous version of this class. To maintain |
97 |
|
|
* interoperability, a plain PriorityQueue is still used during |
98 |
jsr166 |
1.77 |
* serialization, which maintains compatibility at the expense of |
99 |
dl |
1.66 |
* transiently doubling overhead. |
100 |
dl |
1.59 |
*/ |
101 |
|
|
|
102 |
|
|
/** |
103 |
|
|
* Default array capacity. |
104 |
|
|
*/ |
105 |
|
|
private static final int DEFAULT_INITIAL_CAPACITY = 11; |
106 |
|
|
|
107 |
|
|
/** |
108 |
dl |
1.66 |
* The maximum size of array to allocate. |
109 |
|
|
* Some VMs reserve some header words in an array. |
110 |
|
|
* Attempts to allocate larger arrays may result in |
111 |
|
|
* OutOfMemoryError: Requested array size exceeds VM limit |
112 |
|
|
*/ |
113 |
|
|
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; |
114 |
|
|
|
115 |
|
|
/** |
116 |
dl |
1.59 |
* Priority queue represented as a balanced binary heap: the two |
117 |
|
|
* children of queue[n] are queue[2*n+1] and queue[2*(n+1)]. The |
118 |
|
|
* priority queue is ordered by comparator, or by the elements' |
119 |
|
|
* natural ordering, if comparator is null: For each node n in the |
120 |
|
|
* heap and each descendant d of n, n <= d. The element with the |
121 |
|
|
* lowest value is in queue[0], assuming the queue is nonempty. |
122 |
|
|
*/ |
123 |
|
|
private transient Object[] queue; |
124 |
|
|
|
125 |
|
|
/** |
126 |
|
|
* The number of elements in the priority queue. |
127 |
|
|
*/ |
128 |
dl |
1.66 |
private transient int size; |
129 |
dl |
1.59 |
|
130 |
|
|
/** |
131 |
|
|
* The comparator, or null if priority queue uses elements' |
132 |
|
|
* natural ordering. |
133 |
|
|
*/ |
134 |
|
|
private transient Comparator<? super E> comparator; |
135 |
|
|
|
136 |
|
|
/** |
137 |
jsr166 |
1.112 |
* Lock used for all public operations. |
138 |
dl |
1.59 |
*/ |
139 |
dl |
1.66 |
private final ReentrantLock lock; |
140 |
dl |
1.59 |
|
141 |
|
|
/** |
142 |
jsr166 |
1.112 |
* Condition for blocking when empty. |
143 |
dl |
1.59 |
*/ |
144 |
dl |
1.66 |
private final Condition notEmpty; |
145 |
dl |
1.5 |
|
146 |
dl |
1.2 |
/** |
147 |
dl |
1.59 |
* Spinlock for allocation, acquired via CAS. |
148 |
|
|
*/ |
149 |
|
|
private transient volatile int allocationSpinLock; |
150 |
|
|
|
151 |
|
|
/** |
152 |
dl |
1.66 |
* A plain PriorityQueue used only for serialization, |
153 |
|
|
* to maintain compatibility with previous versions |
154 |
|
|
* of this class. Non-null only during serialization/deserialization. |
155 |
|
|
*/ |
156 |
jsr166 |
1.72 |
private PriorityQueue<E> q; |
157 |
dl |
1.66 |
|
158 |
|
|
/** |
159 |
jsr166 |
1.63 |
* Creates a {@code PriorityBlockingQueue} with the default |
160 |
jsr166 |
1.42 |
* initial capacity (11) that orders its elements according to |
161 |
|
|
* their {@linkplain Comparable natural ordering}. |
162 |
dl |
1.2 |
*/ |
163 |
|
|
public PriorityBlockingQueue() { |
164 |
dl |
1.59 |
this(DEFAULT_INITIAL_CAPACITY, null); |
165 |
dl |
1.2 |
} |
166 |
|
|
|
167 |
|
|
/** |
168 |
jsr166 |
1.63 |
* Creates a {@code PriorityBlockingQueue} with the specified |
169 |
jsr166 |
1.42 |
* initial capacity that orders its elements according to their |
170 |
|
|
* {@linkplain Comparable natural ordering}. |
171 |
dl |
1.2 |
* |
172 |
jsr166 |
1.42 |
* @param initialCapacity the initial capacity for this priority queue |
173 |
jsr166 |
1.63 |
* @throws IllegalArgumentException if {@code initialCapacity} is less |
174 |
jsr166 |
1.52 |
* than 1 |
175 |
dl |
1.2 |
*/ |
176 |
|
|
public PriorityBlockingQueue(int initialCapacity) { |
177 |
dl |
1.59 |
this(initialCapacity, null); |
178 |
dl |
1.2 |
} |
179 |
|
|
|
180 |
|
|
/** |
181 |
jsr166 |
1.63 |
* Creates a {@code PriorityBlockingQueue} with the specified initial |
182 |
jsr166 |
1.39 |
* capacity that orders its elements according to the specified |
183 |
|
|
* comparator. |
184 |
dl |
1.2 |
* |
185 |
jsr166 |
1.42 |
* @param initialCapacity the initial capacity for this priority queue |
186 |
jsr166 |
1.52 |
* @param comparator the comparator that will be used to order this |
187 |
|
|
* priority queue. If {@code null}, the {@linkplain Comparable |
188 |
|
|
* natural ordering} of the elements will be used. |
189 |
jsr166 |
1.63 |
* @throws IllegalArgumentException if {@code initialCapacity} is less |
190 |
jsr166 |
1.52 |
* than 1 |
191 |
dl |
1.2 |
*/ |
192 |
tim |
1.13 |
public PriorityBlockingQueue(int initialCapacity, |
193 |
dholmes |
1.14 |
Comparator<? super E> comparator) { |
194 |
dl |
1.59 |
if (initialCapacity < 1) |
195 |
|
|
throw new IllegalArgumentException(); |
196 |
dl |
1.66 |
this.lock = new ReentrantLock(); |
197 |
|
|
this.notEmpty = lock.newCondition(); |
198 |
|
|
this.comparator = comparator; |
199 |
dl |
1.59 |
this.queue = new Object[initialCapacity]; |
200 |
dl |
1.2 |
} |
201 |
|
|
|
202 |
|
|
/** |
203 |
jsr166 |
1.63 |
* Creates a {@code PriorityBlockingQueue} containing the elements |
204 |
jsr166 |
1.52 |
* in the specified collection. If the specified collection is a |
205 |
jsr166 |
1.99 |
* {@link SortedSet} or a {@link PriorityQueue}, this |
206 |
jsr166 |
1.52 |
* priority queue will be ordered according to the same ordering. |
207 |
|
|
* Otherwise, this priority queue will be ordered according to the |
208 |
|
|
* {@linkplain Comparable natural ordering} of its elements. |
209 |
dl |
1.2 |
* |
210 |
jsr166 |
1.52 |
* @param c the collection whose elements are to be placed |
211 |
|
|
* into this priority queue |
212 |
dl |
1.2 |
* @throws ClassCastException if elements of the specified collection |
213 |
|
|
* cannot be compared to one another according to the priority |
214 |
jsr166 |
1.52 |
* queue's ordering |
215 |
jsr166 |
1.42 |
* @throws NullPointerException if the specified collection or any |
216 |
|
|
* of its elements are null |
217 |
dl |
1.2 |
*/ |
218 |
dholmes |
1.14 |
public PriorityBlockingQueue(Collection<? extends E> c) { |
219 |
dl |
1.66 |
this.lock = new ReentrantLock(); |
220 |
|
|
this.notEmpty = lock.newCondition(); |
221 |
|
|
boolean heapify = true; // true if not known to be in heap order |
222 |
|
|
boolean screen = true; // true if must screen for nulls |
223 |
dl |
1.59 |
if (c instanceof SortedSet<?>) { |
224 |
|
|
SortedSet<? extends E> ss = (SortedSet<? extends E>) c; |
225 |
|
|
this.comparator = (Comparator<? super E>) ss.comparator(); |
226 |
dl |
1.66 |
heapify = false; |
227 |
dl |
1.59 |
} |
228 |
|
|
else if (c instanceof PriorityBlockingQueue<?>) { |
229 |
jsr166 |
1.61 |
PriorityBlockingQueue<? extends E> pq = |
230 |
dl |
1.59 |
(PriorityBlockingQueue<? extends E>) c; |
231 |
|
|
this.comparator = (Comparator<? super E>) pq.comparator(); |
232 |
jsr166 |
1.67 |
screen = false; |
233 |
dl |
1.66 |
if (pq.getClass() == PriorityBlockingQueue.class) // exact match |
234 |
|
|
heapify = false; |
235 |
dl |
1.59 |
} |
236 |
|
|
Object[] a = c.toArray(); |
237 |
dl |
1.66 |
int n = a.length; |
238 |
dl |
1.59 |
// If c.toArray incorrectly doesn't return Object[], copy it. |
239 |
|
|
if (a.getClass() != Object[].class) |
240 |
dl |
1.66 |
a = Arrays.copyOf(a, n, Object[].class); |
241 |
|
|
if (screen && (n == 1 || this.comparator != null)) { |
242 |
|
|
for (int i = 0; i < n; ++i) |
243 |
dl |
1.59 |
if (a[i] == null) |
244 |
|
|
throw new NullPointerException(); |
245 |
dl |
1.66 |
} |
246 |
dl |
1.59 |
this.queue = a; |
247 |
dl |
1.66 |
this.size = n; |
248 |
|
|
if (heapify) |
249 |
|
|
heapify(); |
250 |
dl |
1.59 |
} |
251 |
|
|
|
252 |
|
|
/** |
253 |
dl |
1.66 |
* Tries to grow array to accommodate at least one more element |
254 |
|
|
* (but normally expand by about 50%), giving up (allowing retry) |
255 |
|
|
* on contention (which we expect to be rare). Call only while |
256 |
|
|
* holding lock. |
257 |
jsr166 |
1.67 |
* |
258 |
dl |
1.66 |
* @param array the heap array |
259 |
|
|
* @param oldCap the length of the array |
260 |
dl |
1.59 |
*/ |
261 |
dl |
1.66 |
private void tryGrow(Object[] array, int oldCap) { |
262 |
dl |
1.59 |
lock.unlock(); // must release and then re-acquire main lock |
263 |
|
|
Object[] newArray = null; |
264 |
|
|
if (allocationSpinLock == 0 && |
265 |
dl |
1.115 |
ALLOCATIONSPINLOCK.compareAndSet(this, 0, 1)) { |
266 |
dl |
1.59 |
try { |
267 |
|
|
int newCap = oldCap + ((oldCap < 64) ? |
268 |
dl |
1.66 |
(oldCap + 2) : // grow faster if small |
269 |
dl |
1.59 |
(oldCap >> 1)); |
270 |
dl |
1.66 |
if (newCap - MAX_ARRAY_SIZE > 0) { // possible overflow |
271 |
|
|
int minCap = oldCap + 1; |
272 |
dl |
1.59 |
if (minCap < 0 || minCap > MAX_ARRAY_SIZE) |
273 |
|
|
throw new OutOfMemoryError(); |
274 |
|
|
newCap = MAX_ARRAY_SIZE; |
275 |
|
|
} |
276 |
dl |
1.66 |
if (newCap > oldCap && queue == array) |
277 |
dl |
1.59 |
newArray = new Object[newCap]; |
278 |
|
|
} finally { |
279 |
|
|
allocationSpinLock = 0; |
280 |
|
|
} |
281 |
|
|
} |
282 |
dl |
1.66 |
if (newArray == null) // back off if another thread is allocating |
283 |
dl |
1.59 |
Thread.yield(); |
284 |
|
|
lock.lock(); |
285 |
|
|
if (newArray != null && queue == array) { |
286 |
|
|
queue = newArray; |
287 |
dl |
1.66 |
System.arraycopy(array, 0, newArray, 0, oldCap); |
288 |
dl |
1.59 |
} |
289 |
|
|
} |
290 |
|
|
|
291 |
|
|
/** |
292 |
jsr166 |
1.62 |
* Mechanics for poll(). Call only while holding lock. |
293 |
dl |
1.59 |
*/ |
294 |
jsr166 |
1.79 |
private E dequeue() { |
295 |
dl |
1.66 |
int n = size - 1; |
296 |
|
|
if (n < 0) |
297 |
jsr166 |
1.74 |
return null; |
298 |
dl |
1.66 |
else { |
299 |
|
|
Object[] array = queue; |
300 |
jsr166 |
1.74 |
E result = (E) array[0]; |
301 |
dl |
1.66 |
E x = (E) array[n]; |
302 |
|
|
array[n] = null; |
303 |
|
|
Comparator<? super E> cmp = comparator; |
304 |
|
|
if (cmp == null) |
305 |
|
|
siftDownComparable(0, x, array, n); |
306 |
jsr166 |
1.67 |
else |
307 |
dl |
1.66 |
siftDownUsingComparator(0, x, array, n, cmp); |
308 |
|
|
size = n; |
309 |
jsr166 |
1.74 |
return result; |
310 |
dl |
1.59 |
} |
311 |
|
|
} |
312 |
|
|
|
313 |
|
|
/** |
314 |
|
|
* Inserts item x at position k, maintaining heap invariant by |
315 |
|
|
* promoting x up the tree until it is greater than or equal to |
316 |
|
|
* its parent, or is the root. |
317 |
|
|
* |
318 |
|
|
* To simplify and speed up coercions and comparisons. the |
319 |
|
|
* Comparable and Comparator versions are separated into different |
320 |
|
|
* methods that are otherwise identical. (Similarly for siftDown.) |
321 |
dl |
1.66 |
* These methods are static, with heap state as arguments, to |
322 |
|
|
* simplify use in light of possible comparator exceptions. |
323 |
dl |
1.59 |
* |
324 |
|
|
* @param k the position to fill |
325 |
|
|
* @param x the item to insert |
326 |
dl |
1.66 |
* @param array the heap array |
327 |
dl |
1.59 |
*/ |
328 |
dl |
1.66 |
private static <T> void siftUpComparable(int k, T x, Object[] array) { |
329 |
|
|
Comparable<? super T> key = (Comparable<? super T>) x; |
330 |
dl |
1.59 |
while (k > 0) { |
331 |
|
|
int parent = (k - 1) >>> 1; |
332 |
dl |
1.66 |
Object e = array[parent]; |
333 |
|
|
if (key.compareTo((T) e) >= 0) |
334 |
dl |
1.59 |
break; |
335 |
dl |
1.66 |
array[k] = e; |
336 |
dl |
1.59 |
k = parent; |
337 |
|
|
} |
338 |
dl |
1.66 |
array[k] = key; |
339 |
dl |
1.59 |
} |
340 |
|
|
|
341 |
dl |
1.66 |
private static <T> void siftUpUsingComparator(int k, T x, Object[] array, |
342 |
|
|
Comparator<? super T> cmp) { |
343 |
dl |
1.59 |
while (k > 0) { |
344 |
|
|
int parent = (k - 1) >>> 1; |
345 |
dl |
1.66 |
Object e = array[parent]; |
346 |
|
|
if (cmp.compare(x, (T) e) >= 0) |
347 |
dl |
1.59 |
break; |
348 |
dl |
1.66 |
array[k] = e; |
349 |
dl |
1.59 |
k = parent; |
350 |
|
|
} |
351 |
dl |
1.66 |
array[k] = x; |
352 |
dl |
1.59 |
} |
353 |
|
|
|
354 |
|
|
/** |
355 |
|
|
* Inserts item x at position k, maintaining heap invariant by |
356 |
|
|
* demoting x down the tree repeatedly until it is less than or |
357 |
|
|
* equal to its children or is a leaf. |
358 |
|
|
* |
359 |
|
|
* @param k the position to fill |
360 |
|
|
* @param x the item to insert |
361 |
dl |
1.66 |
* @param array the heap array |
362 |
|
|
* @param n heap size |
363 |
dl |
1.59 |
*/ |
364 |
jsr166 |
1.67 |
private static <T> void siftDownComparable(int k, T x, Object[] array, |
365 |
dl |
1.66 |
int n) { |
366 |
dl |
1.85 |
if (n > 0) { |
367 |
|
|
Comparable<? super T> key = (Comparable<? super T>)x; |
368 |
|
|
int half = n >>> 1; // loop while a non-leaf |
369 |
|
|
while (k < half) { |
370 |
|
|
int child = (k << 1) + 1; // assume left child is least |
371 |
|
|
Object c = array[child]; |
372 |
|
|
int right = child + 1; |
373 |
|
|
if (right < n && |
374 |
|
|
((Comparable<? super T>) c).compareTo((T) array[right]) > 0) |
375 |
|
|
c = array[child = right]; |
376 |
|
|
if (key.compareTo((T) c) <= 0) |
377 |
|
|
break; |
378 |
|
|
array[k] = c; |
379 |
|
|
k = child; |
380 |
|
|
} |
381 |
|
|
array[k] = key; |
382 |
dl |
1.59 |
} |
383 |
|
|
} |
384 |
|
|
|
385 |
dl |
1.66 |
private static <T> void siftDownUsingComparator(int k, T x, Object[] array, |
386 |
|
|
int n, |
387 |
|
|
Comparator<? super T> cmp) { |
388 |
dl |
1.85 |
if (n > 0) { |
389 |
|
|
int half = n >>> 1; |
390 |
|
|
while (k < half) { |
391 |
|
|
int child = (k << 1) + 1; |
392 |
|
|
Object c = array[child]; |
393 |
|
|
int right = child + 1; |
394 |
|
|
if (right < n && cmp.compare((T) c, (T) array[right]) > 0) |
395 |
|
|
c = array[child = right]; |
396 |
|
|
if (cmp.compare(x, (T) c) <= 0) |
397 |
|
|
break; |
398 |
|
|
array[k] = c; |
399 |
|
|
k = child; |
400 |
|
|
} |
401 |
|
|
array[k] = x; |
402 |
dl |
1.59 |
} |
403 |
dl |
1.7 |
} |
404 |
|
|
|
405 |
dholmes |
1.10 |
/** |
406 |
dl |
1.59 |
* Establishes the heap invariant (described above) in the entire tree, |
407 |
|
|
* assuming nothing about the order of the elements prior to the call. |
408 |
|
|
*/ |
409 |
|
|
private void heapify() { |
410 |
dl |
1.66 |
Object[] array = queue; |
411 |
|
|
int n = size; |
412 |
|
|
int half = (n >>> 1) - 1; |
413 |
|
|
Comparator<? super E> cmp = comparator; |
414 |
|
|
if (cmp == null) { |
415 |
|
|
for (int i = half; i >= 0; i--) |
416 |
|
|
siftDownComparable(i, (E) array[i], array, n); |
417 |
|
|
} |
418 |
|
|
else { |
419 |
|
|
for (int i = half; i >= 0; i--) |
420 |
|
|
siftDownUsingComparator(i, (E) array[i], array, n, cmp); |
421 |
|
|
} |
422 |
dl |
1.59 |
} |
423 |
|
|
|
424 |
|
|
/** |
425 |
jsr166 |
1.42 |
* Inserts the specified element into this priority queue. |
426 |
|
|
* |
427 |
jsr166 |
1.40 |
* @param e the element to add |
428 |
jsr166 |
1.63 |
* @return {@code true} (as specified by {@link Collection#add}) |
429 |
dholmes |
1.16 |
* @throws ClassCastException if the specified element cannot be compared |
430 |
jsr166 |
1.42 |
* with elements currently in the priority queue according to the |
431 |
|
|
* priority queue's ordering |
432 |
|
|
* @throws NullPointerException if the specified element is null |
433 |
dholmes |
1.10 |
*/ |
434 |
jsr166 |
1.40 |
public boolean add(E e) { |
435 |
jsr166 |
1.42 |
return offer(e); |
436 |
dl |
1.5 |
} |
437 |
|
|
|
438 |
dholmes |
1.16 |
/** |
439 |
dl |
1.24 |
* Inserts the specified element into this priority queue. |
440 |
jsr166 |
1.64 |
* As the queue is unbounded, this method will never return {@code false}. |
441 |
dholmes |
1.16 |
* |
442 |
jsr166 |
1.40 |
* @param e the element to add |
443 |
jsr166 |
1.63 |
* @return {@code true} (as specified by {@link Queue#offer}) |
444 |
dholmes |
1.16 |
* @throws ClassCastException if the specified element cannot be compared |
445 |
jsr166 |
1.42 |
* with elements currently in the priority queue according to the |
446 |
|
|
* priority queue's ordering |
447 |
|
|
* @throws NullPointerException if the specified element is null |
448 |
dholmes |
1.16 |
*/ |
449 |
jsr166 |
1.40 |
public boolean offer(E e) { |
450 |
dl |
1.59 |
if (e == null) |
451 |
|
|
throw new NullPointerException(); |
452 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
453 |
dl |
1.5 |
lock.lock(); |
454 |
dl |
1.66 |
int n, cap; |
455 |
dl |
1.59 |
Object[] array; |
456 |
dl |
1.66 |
while ((n = size) >= (cap = (array = queue).length)) |
457 |
|
|
tryGrow(array, cap); |
458 |
dl |
1.59 |
try { |
459 |
dl |
1.66 |
Comparator<? super E> cmp = comparator; |
460 |
|
|
if (cmp == null) |
461 |
|
|
siftUpComparable(n, e, array); |
462 |
dl |
1.59 |
else |
463 |
dl |
1.66 |
siftUpUsingComparator(n, e, array, cmp); |
464 |
|
|
size = n + 1; |
465 |
dl |
1.5 |
notEmpty.signal(); |
466 |
tim |
1.19 |
} finally { |
467 |
tim |
1.13 |
lock.unlock(); |
468 |
dl |
1.5 |
} |
469 |
dl |
1.59 |
return true; |
470 |
dl |
1.5 |
} |
471 |
|
|
|
472 |
dholmes |
1.16 |
/** |
473 |
jsr166 |
1.64 |
* Inserts the specified element into this priority queue. |
474 |
|
|
* As the queue is unbounded, this method will never block. |
475 |
jsr166 |
1.42 |
* |
476 |
jsr166 |
1.40 |
* @param e the element to add |
477 |
jsr166 |
1.42 |
* @throws ClassCastException if the specified element cannot be compared |
478 |
|
|
* with elements currently in the priority queue according to the |
479 |
|
|
* priority queue's ordering |
480 |
|
|
* @throws NullPointerException if the specified element is null |
481 |
dholmes |
1.16 |
*/ |
482 |
jsr166 |
1.40 |
public void put(E e) { |
483 |
|
|
offer(e); // never need to block |
484 |
dl |
1.5 |
} |
485 |
|
|
|
486 |
dholmes |
1.16 |
/** |
487 |
jsr166 |
1.64 |
* Inserts the specified element into this priority queue. |
488 |
|
|
* As the queue is unbounded, this method will never block or |
489 |
|
|
* return {@code false}. |
490 |
jsr166 |
1.42 |
* |
491 |
jsr166 |
1.40 |
* @param e the element to add |
492 |
dholmes |
1.16 |
* @param timeout This parameter is ignored as the method never blocks |
493 |
|
|
* @param unit This parameter is ignored as the method never blocks |
494 |
jsr166 |
1.65 |
* @return {@code true} (as specified by |
495 |
|
|
* {@link BlockingQueue#offer(Object,long,TimeUnit) BlockingQueue.offer}) |
496 |
jsr166 |
1.42 |
* @throws ClassCastException if the specified element cannot be compared |
497 |
|
|
* with elements currently in the priority queue according to the |
498 |
|
|
* priority queue's ordering |
499 |
|
|
* @throws NullPointerException if the specified element is null |
500 |
dholmes |
1.16 |
*/ |
501 |
jsr166 |
1.40 |
public boolean offer(E e, long timeout, TimeUnit unit) { |
502 |
|
|
return offer(e); // never need to block |
503 |
dl |
1.5 |
} |
504 |
|
|
|
505 |
jsr166 |
1.42 |
public E poll() { |
506 |
|
|
final ReentrantLock lock = this.lock; |
507 |
|
|
lock.lock(); |
508 |
|
|
try { |
509 |
jsr166 |
1.79 |
return dequeue(); |
510 |
jsr166 |
1.42 |
} finally { |
511 |
|
|
lock.unlock(); |
512 |
|
|
} |
513 |
|
|
} |
514 |
|
|
|
515 |
dl |
1.5 |
public E take() throws InterruptedException { |
516 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
517 |
dl |
1.5 |
lock.lockInterruptibly(); |
518 |
dl |
1.66 |
E result; |
519 |
dl |
1.5 |
try { |
520 |
jsr166 |
1.79 |
while ( (result = dequeue()) == null) |
521 |
jsr166 |
1.55 |
notEmpty.await(); |
522 |
tim |
1.19 |
} finally { |
523 |
dl |
1.5 |
lock.unlock(); |
524 |
|
|
} |
525 |
dl |
1.59 |
return result; |
526 |
dl |
1.5 |
} |
527 |
|
|
|
528 |
|
|
public E poll(long timeout, TimeUnit unit) throws InterruptedException { |
529 |
dholmes |
1.10 |
long nanos = unit.toNanos(timeout); |
530 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
531 |
dl |
1.5 |
lock.lockInterruptibly(); |
532 |
dl |
1.66 |
E result; |
533 |
dl |
1.5 |
try { |
534 |
jsr166 |
1.79 |
while ( (result = dequeue()) == null && nanos > 0) |
535 |
jsr166 |
1.55 |
nanos = notEmpty.awaitNanos(nanos); |
536 |
tim |
1.19 |
} finally { |
537 |
dl |
1.5 |
lock.unlock(); |
538 |
|
|
} |
539 |
dl |
1.59 |
return result; |
540 |
dl |
1.5 |
} |
541 |
|
|
|
542 |
|
|
public E peek() { |
543 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
544 |
dl |
1.5 |
lock.lock(); |
545 |
|
|
try { |
546 |
jsr166 |
1.74 |
return (size == 0) ? null : (E) queue[0]; |
547 |
tim |
1.19 |
} finally { |
548 |
tim |
1.13 |
lock.unlock(); |
549 |
dl |
1.5 |
} |
550 |
|
|
} |
551 |
jsr166 |
1.61 |
|
552 |
jsr166 |
1.42 |
/** |
553 |
|
|
* Returns the comparator used to order the elements in this queue, |
554 |
jsr166 |
1.63 |
* or {@code null} if this queue uses the {@linkplain Comparable |
555 |
jsr166 |
1.42 |
* natural ordering} of its elements. |
556 |
|
|
* |
557 |
|
|
* @return the comparator used to order the elements in this queue, |
558 |
jsr166 |
1.63 |
* or {@code null} if this queue uses the natural |
559 |
jsr166 |
1.52 |
* ordering of its elements |
560 |
jsr166 |
1.42 |
*/ |
561 |
|
|
public Comparator<? super E> comparator() { |
562 |
dl |
1.59 |
return comparator; |
563 |
jsr166 |
1.42 |
} |
564 |
|
|
|
565 |
dl |
1.5 |
public int size() { |
566 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
567 |
dl |
1.5 |
lock.lock(); |
568 |
|
|
try { |
569 |
jsr166 |
1.68 |
return size; |
570 |
tim |
1.19 |
} finally { |
571 |
dl |
1.5 |
lock.unlock(); |
572 |
|
|
} |
573 |
|
|
} |
574 |
|
|
|
575 |
|
|
/** |
576 |
jsr166 |
1.63 |
* Always returns {@code Integer.MAX_VALUE} because |
577 |
|
|
* a {@code PriorityBlockingQueue} is not capacity constrained. |
578 |
|
|
* @return {@code Integer.MAX_VALUE} always |
579 |
dl |
1.5 |
*/ |
580 |
|
|
public int remainingCapacity() { |
581 |
|
|
return Integer.MAX_VALUE; |
582 |
|
|
} |
583 |
|
|
|
584 |
dl |
1.59 |
private int indexOf(Object o) { |
585 |
|
|
if (o != null) { |
586 |
dl |
1.66 |
Object[] array = queue; |
587 |
|
|
int n = size; |
588 |
|
|
for (int i = 0; i < n; i++) |
589 |
|
|
if (o.equals(array[i])) |
590 |
dl |
1.59 |
return i; |
591 |
|
|
} |
592 |
|
|
return -1; |
593 |
|
|
} |
594 |
|
|
|
595 |
|
|
/** |
596 |
|
|
* Removes the ith element from queue. |
597 |
|
|
*/ |
598 |
|
|
private void removeAt(int i) { |
599 |
dl |
1.66 |
Object[] array = queue; |
600 |
|
|
int n = size - 1; |
601 |
|
|
if (n == i) // removed last element |
602 |
|
|
array[i] = null; |
603 |
dl |
1.59 |
else { |
604 |
dl |
1.66 |
E moved = (E) array[n]; |
605 |
|
|
array[n] = null; |
606 |
|
|
Comparator<? super E> cmp = comparator; |
607 |
jsr166 |
1.67 |
if (cmp == null) |
608 |
dl |
1.66 |
siftDownComparable(i, moved, array, n); |
609 |
|
|
else |
610 |
|
|
siftDownUsingComparator(i, moved, array, n, cmp); |
611 |
|
|
if (array[i] == moved) { |
612 |
|
|
if (cmp == null) |
613 |
|
|
siftUpComparable(i, moved, array); |
614 |
|
|
else |
615 |
|
|
siftUpUsingComparator(i, moved, array, cmp); |
616 |
|
|
} |
617 |
dl |
1.59 |
} |
618 |
dl |
1.66 |
size = n; |
619 |
dl |
1.59 |
} |
620 |
|
|
|
621 |
dl |
1.37 |
/** |
622 |
jsr166 |
1.42 |
* Removes a single instance of the specified element from this queue, |
623 |
jsr166 |
1.52 |
* if it is present. More formally, removes an element {@code e} such |
624 |
|
|
* that {@code o.equals(e)}, if this queue contains one or more such |
625 |
|
|
* elements. Returns {@code true} if and only if this queue contained |
626 |
|
|
* the specified element (or equivalently, if this queue changed as a |
627 |
|
|
* result of the call). |
628 |
jsr166 |
1.42 |
* |
629 |
|
|
* @param o element to be removed from this queue, if present |
630 |
jsr166 |
1.63 |
* @return {@code true} if this queue changed as a result of the call |
631 |
dl |
1.37 |
*/ |
632 |
dholmes |
1.14 |
public boolean remove(Object o) { |
633 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
634 |
dl |
1.5 |
lock.lock(); |
635 |
|
|
try { |
636 |
dl |
1.59 |
int i = indexOf(o); |
637 |
jsr166 |
1.78 |
if (i == -1) |
638 |
|
|
return false; |
639 |
|
|
removeAt(i); |
640 |
|
|
return true; |
641 |
dl |
1.59 |
} finally { |
642 |
|
|
lock.unlock(); |
643 |
|
|
} |
644 |
|
|
} |
645 |
|
|
|
646 |
|
|
/** |
647 |
jsr166 |
1.112 |
* Identity-based version for use in Itr.remove. |
648 |
dl |
1.59 |
*/ |
649 |
jsr166 |
1.80 |
void removeEQ(Object o) { |
650 |
dl |
1.59 |
final ReentrantLock lock = this.lock; |
651 |
|
|
lock.lock(); |
652 |
|
|
try { |
653 |
dl |
1.66 |
Object[] array = queue; |
654 |
jsr166 |
1.78 |
for (int i = 0, n = size; i < n; i++) { |
655 |
dl |
1.66 |
if (o == array[i]) { |
656 |
dl |
1.59 |
removeAt(i); |
657 |
|
|
break; |
658 |
|
|
} |
659 |
|
|
} |
660 |
tim |
1.19 |
} finally { |
661 |
dl |
1.5 |
lock.unlock(); |
662 |
|
|
} |
663 |
|
|
} |
664 |
|
|
|
665 |
jsr166 |
1.42 |
/** |
666 |
jsr166 |
1.52 |
* Returns {@code true} if this queue contains the specified element. |
667 |
|
|
* More formally, returns {@code true} if and only if this queue contains |
668 |
|
|
* at least one element {@code e} such that {@code o.equals(e)}. |
669 |
jsr166 |
1.42 |
* |
670 |
|
|
* @param o object to be checked for containment in this queue |
671 |
jsr166 |
1.63 |
* @return {@code true} if this queue contains the specified element |
672 |
jsr166 |
1.42 |
*/ |
673 |
dholmes |
1.14 |
public boolean contains(Object o) { |
674 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
675 |
dl |
1.5 |
lock.lock(); |
676 |
|
|
try { |
677 |
jsr166 |
1.78 |
return indexOf(o) != -1; |
678 |
tim |
1.19 |
} finally { |
679 |
dl |
1.5 |
lock.unlock(); |
680 |
|
|
} |
681 |
|
|
} |
682 |
|
|
|
683 |
|
|
public String toString() { |
684 |
jsr166 |
1.111 |
return Helpers.collectionToString(this); |
685 |
dl |
1.5 |
} |
686 |
|
|
|
687 |
jsr166 |
1.42 |
/** |
688 |
|
|
* @throws UnsupportedOperationException {@inheritDoc} |
689 |
|
|
* @throws ClassCastException {@inheritDoc} |
690 |
|
|
* @throws NullPointerException {@inheritDoc} |
691 |
|
|
* @throws IllegalArgumentException {@inheritDoc} |
692 |
|
|
*/ |
693 |
dl |
1.26 |
public int drainTo(Collection<? super E> c) { |
694 |
jsr166 |
1.76 |
return drainTo(c, Integer.MAX_VALUE); |
695 |
dl |
1.26 |
} |
696 |
|
|
|
697 |
jsr166 |
1.42 |
/** |
698 |
|
|
* @throws UnsupportedOperationException {@inheritDoc} |
699 |
|
|
* @throws ClassCastException {@inheritDoc} |
700 |
|
|
* @throws NullPointerException {@inheritDoc} |
701 |
|
|
* @throws IllegalArgumentException {@inheritDoc} |
702 |
|
|
*/ |
703 |
dl |
1.26 |
public int drainTo(Collection<? super E> c, int maxElements) { |
704 |
|
|
if (c == null) |
705 |
|
|
throw new NullPointerException(); |
706 |
|
|
if (c == this) |
707 |
|
|
throw new IllegalArgumentException(); |
708 |
|
|
if (maxElements <= 0) |
709 |
|
|
return 0; |
710 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
711 |
dl |
1.26 |
lock.lock(); |
712 |
|
|
try { |
713 |
jsr166 |
1.76 |
int n = Math.min(size, maxElements); |
714 |
|
|
for (int i = 0; i < n; i++) { |
715 |
|
|
c.add((E) queue[0]); // In this order, in case add() throws. |
716 |
jsr166 |
1.79 |
dequeue(); |
717 |
dl |
1.26 |
} |
718 |
|
|
return n; |
719 |
|
|
} finally { |
720 |
|
|
lock.unlock(); |
721 |
|
|
} |
722 |
|
|
} |
723 |
|
|
|
724 |
dl |
1.17 |
/** |
725 |
dl |
1.37 |
* Atomically removes all of the elements from this queue. |
726 |
dl |
1.17 |
* The queue will be empty after this call returns. |
727 |
|
|
*/ |
728 |
|
|
public void clear() { |
729 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
730 |
dl |
1.17 |
lock.lock(); |
731 |
|
|
try { |
732 |
dl |
1.66 |
Object[] array = queue; |
733 |
|
|
int n = size; |
734 |
dl |
1.59 |
size = 0; |
735 |
dl |
1.66 |
for (int i = 0; i < n; i++) |
736 |
|
|
array[i] = null; |
737 |
tim |
1.19 |
} finally { |
738 |
dl |
1.17 |
lock.unlock(); |
739 |
|
|
} |
740 |
|
|
} |
741 |
|
|
|
742 |
jsr166 |
1.42 |
/** |
743 |
jsr166 |
1.110 |
* Returns an array containing all of the elements in this queue. |
744 |
|
|
* The returned array elements are in no particular order. |
745 |
|
|
* |
746 |
|
|
* <p>The returned array will be "safe" in that no references to it are |
747 |
|
|
* maintained by this queue. (In other words, this method must allocate |
748 |
|
|
* a new array). The caller is thus free to modify the returned array. |
749 |
|
|
* |
750 |
|
|
* <p>This method acts as bridge between array-based and collection-based |
751 |
|
|
* APIs. |
752 |
|
|
* |
753 |
|
|
* @return an array containing all of the elements in this queue |
754 |
|
|
*/ |
755 |
|
|
public Object[] toArray() { |
756 |
|
|
final ReentrantLock lock = this.lock; |
757 |
|
|
lock.lock(); |
758 |
|
|
try { |
759 |
|
|
return Arrays.copyOf(queue, size); |
760 |
|
|
} finally { |
761 |
|
|
lock.unlock(); |
762 |
|
|
} |
763 |
|
|
} |
764 |
|
|
|
765 |
|
|
/** |
766 |
jsr166 |
1.42 |
* Returns an array containing all of the elements in this queue; the |
767 |
|
|
* runtime type of the returned array is that of the specified array. |
768 |
|
|
* The returned array elements are in no particular order. |
769 |
|
|
* If the queue fits in the specified array, it is returned therein. |
770 |
|
|
* Otherwise, a new array is allocated with the runtime type of the |
771 |
|
|
* specified array and the size of this queue. |
772 |
|
|
* |
773 |
|
|
* <p>If this queue fits in the specified array with room to spare |
774 |
|
|
* (i.e., the array has more elements than this queue), the element in |
775 |
|
|
* the array immediately following the end of the queue is set to |
776 |
jsr166 |
1.63 |
* {@code null}. |
777 |
jsr166 |
1.42 |
* |
778 |
|
|
* <p>Like the {@link #toArray()} method, this method acts as bridge between |
779 |
|
|
* array-based and collection-based APIs. Further, this method allows |
780 |
|
|
* precise control over the runtime type of the output array, and may, |
781 |
|
|
* under certain circumstances, be used to save allocation costs. |
782 |
|
|
* |
783 |
jsr166 |
1.63 |
* <p>Suppose {@code x} is a queue known to contain only strings. |
784 |
jsr166 |
1.42 |
* The following code can be used to dump the queue into a newly |
785 |
jsr166 |
1.63 |
* allocated array of {@code String}: |
786 |
jsr166 |
1.42 |
* |
787 |
jsr166 |
1.109 |
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre> |
788 |
jsr166 |
1.42 |
* |
789 |
jsr166 |
1.63 |
* Note that {@code toArray(new Object[0])} is identical in function to |
790 |
|
|
* {@code toArray()}. |
791 |
jsr166 |
1.42 |
* |
792 |
|
|
* @param a the array into which the elements of the queue are to |
793 |
|
|
* be stored, if it is big enough; otherwise, a new array of the |
794 |
|
|
* same runtime type is allocated for this purpose |
795 |
|
|
* @return an array containing all of the elements in this queue |
796 |
|
|
* @throws ArrayStoreException if the runtime type of the specified array |
797 |
|
|
* is not a supertype of the runtime type of every element in |
798 |
|
|
* this queue |
799 |
|
|
* @throws NullPointerException if the specified array is null |
800 |
|
|
*/ |
801 |
dl |
1.5 |
public <T> T[] toArray(T[] a) { |
802 |
dl |
1.31 |
final ReentrantLock lock = this.lock; |
803 |
dl |
1.5 |
lock.lock(); |
804 |
|
|
try { |
805 |
dl |
1.66 |
int n = size; |
806 |
|
|
if (a.length < n) |
807 |
dl |
1.59 |
// Make a new array of a's runtime type, but my contents: |
808 |
|
|
return (T[]) Arrays.copyOf(queue, size, a.getClass()); |
809 |
dl |
1.66 |
System.arraycopy(queue, 0, a, 0, n); |
810 |
|
|
if (a.length > n) |
811 |
|
|
a[n] = null; |
812 |
dl |
1.59 |
return a; |
813 |
tim |
1.19 |
} finally { |
814 |
dl |
1.5 |
lock.unlock(); |
815 |
|
|
} |
816 |
|
|
} |
817 |
|
|
|
818 |
dholmes |
1.16 |
/** |
819 |
dl |
1.23 |
* Returns an iterator over the elements in this queue. The |
820 |
|
|
* iterator does not return the elements in any particular order. |
821 |
jsr166 |
1.69 |
* |
822 |
jsr166 |
1.103 |
* <p>The returned iterator is |
823 |
|
|
* <a href="package-summary.html#Weakly"><i>weakly consistent</i></a>. |
824 |
dholmes |
1.16 |
* |
825 |
jsr166 |
1.42 |
* @return an iterator over the elements in this queue |
826 |
dholmes |
1.16 |
*/ |
827 |
dl |
1.5 |
public Iterator<E> iterator() { |
828 |
dl |
1.51 |
return new Itr(toArray()); |
829 |
dl |
1.5 |
} |
830 |
|
|
|
831 |
dl |
1.49 |
/** |
832 |
|
|
* Snapshot iterator that works off copy of underlying q array. |
833 |
|
|
*/ |
834 |
dl |
1.59 |
final class Itr implements Iterator<E> { |
835 |
dl |
1.49 |
final Object[] array; // Array of all elements |
836 |
jsr166 |
1.81 |
int cursor; // index of next element to return |
837 |
jsr166 |
1.54 |
int lastRet; // index of last element, or -1 if no such |
838 |
jsr166 |
1.50 |
|
839 |
dl |
1.49 |
Itr(Object[] array) { |
840 |
|
|
lastRet = -1; |
841 |
|
|
this.array = array; |
842 |
dl |
1.5 |
} |
843 |
|
|
|
844 |
tim |
1.13 |
public boolean hasNext() { |
845 |
dl |
1.49 |
return cursor < array.length; |
846 |
tim |
1.13 |
} |
847 |
|
|
|
848 |
|
|
public E next() { |
849 |
dl |
1.49 |
if (cursor >= array.length) |
850 |
|
|
throw new NoSuchElementException(); |
851 |
|
|
lastRet = cursor; |
852 |
|
|
return (E)array[cursor++]; |
853 |
tim |
1.13 |
} |
854 |
|
|
|
855 |
|
|
public void remove() { |
856 |
jsr166 |
1.50 |
if (lastRet < 0) |
857 |
jsr166 |
1.54 |
throw new IllegalStateException(); |
858 |
dl |
1.59 |
removeEQ(array[lastRet]); |
859 |
dl |
1.49 |
lastRet = -1; |
860 |
tim |
1.13 |
} |
861 |
dl |
1.5 |
} |
862 |
|
|
|
863 |
|
|
/** |
864 |
jsr166 |
1.83 |
* Saves this queue to a stream (that is, serializes it). |
865 |
|
|
* |
866 |
|
|
* For compatibility with previous version of this class, elements |
867 |
|
|
* are first copied to a java.util.PriorityQueue, which is then |
868 |
|
|
* serialized. |
869 |
jsr166 |
1.97 |
* |
870 |
|
|
* @param s the stream |
871 |
jsr166 |
1.98 |
* @throws java.io.IOException if an I/O error occurs |
872 |
dl |
1.5 |
*/ |
873 |
|
|
private void writeObject(java.io.ObjectOutputStream s) |
874 |
|
|
throws java.io.IOException { |
875 |
|
|
lock.lock(); |
876 |
|
|
try { |
877 |
jsr166 |
1.78 |
// avoid zero capacity argument |
878 |
|
|
q = new PriorityQueue<E>(Math.max(size, 1), comparator); |
879 |
dl |
1.59 |
q.addAll(this); |
880 |
dl |
1.5 |
s.defaultWriteObject(); |
881 |
dl |
1.66 |
} finally { |
882 |
dl |
1.59 |
q = null; |
883 |
dl |
1.5 |
lock.unlock(); |
884 |
|
|
} |
885 |
tim |
1.1 |
} |
886 |
|
|
|
887 |
dl |
1.59 |
/** |
888 |
jsr166 |
1.83 |
* Reconstitutes this queue from a stream (that is, deserializes it). |
889 |
jsr166 |
1.97 |
* @param s the stream |
890 |
jsr166 |
1.98 |
* @throws ClassNotFoundException if the class of a serialized object |
891 |
|
|
* could not be found |
892 |
|
|
* @throws java.io.IOException if an I/O error occurs |
893 |
dl |
1.59 |
*/ |
894 |
|
|
private void readObject(java.io.ObjectInputStream s) |
895 |
|
|
throws java.io.IOException, ClassNotFoundException { |
896 |
jsr166 |
1.67 |
try { |
897 |
dl |
1.66 |
s.defaultReadObject(); |
898 |
|
|
this.queue = new Object[q.size()]; |
899 |
|
|
comparator = q.comparator(); |
900 |
|
|
addAll(q); |
901 |
jsr166 |
1.67 |
} finally { |
902 |
dl |
1.66 |
q = null; |
903 |
|
|
} |
904 |
dl |
1.59 |
} |
905 |
|
|
|
906 |
dl |
1.93 |
// Similar to Collections.ArraySnapshotSpliterator but avoids |
907 |
|
|
// commitment to toArray until needed |
908 |
|
|
static final class PBQSpliterator<E> implements Spliterator<E> { |
909 |
|
|
final PriorityBlockingQueue<E> queue; |
910 |
|
|
Object[] array; |
911 |
|
|
int index; |
912 |
|
|
int fence; |
913 |
|
|
|
914 |
|
|
PBQSpliterator(PriorityBlockingQueue<E> queue, Object[] array, |
915 |
|
|
int index, int fence) { |
916 |
|
|
this.queue = queue; |
917 |
|
|
this.array = array; |
918 |
|
|
this.index = index; |
919 |
|
|
this.fence = fence; |
920 |
|
|
} |
921 |
|
|
|
922 |
|
|
final int getFence() { |
923 |
|
|
int hi; |
924 |
|
|
if ((hi = fence) < 0) |
925 |
|
|
hi = fence = (array = queue.toArray()).length; |
926 |
|
|
return hi; |
927 |
|
|
} |
928 |
|
|
|
929 |
jsr166 |
1.113 |
public PBQSpliterator<E> trySplit() { |
930 |
dl |
1.93 |
int hi = getFence(), lo = index, mid = (lo + hi) >>> 1; |
931 |
|
|
return (lo >= mid) ? null : |
932 |
|
|
new PBQSpliterator<E>(queue, array, lo, index = mid); |
933 |
|
|
} |
934 |
|
|
|
935 |
|
|
@SuppressWarnings("unchecked") |
936 |
dl |
1.95 |
public void forEachRemaining(Consumer<? super E> action) { |
937 |
dl |
1.93 |
Object[] a; int i, hi; // hoist accesses and checks from loop |
938 |
|
|
if (action == null) |
939 |
|
|
throw new NullPointerException(); |
940 |
|
|
if ((a = array) == null) |
941 |
|
|
fence = (a = queue.toArray()).length; |
942 |
|
|
if ((hi = fence) <= a.length && |
943 |
|
|
(i = index) >= 0 && i < (index = hi)) { |
944 |
|
|
do { action.accept((E)a[i]); } while (++i < hi); |
945 |
|
|
} |
946 |
|
|
} |
947 |
|
|
|
948 |
|
|
public boolean tryAdvance(Consumer<? super E> action) { |
949 |
|
|
if (action == null) |
950 |
|
|
throw new NullPointerException(); |
951 |
|
|
if (getFence() > index && index >= 0) { |
952 |
|
|
@SuppressWarnings("unchecked") E e = (E) array[index++]; |
953 |
|
|
action.accept(e); |
954 |
|
|
return true; |
955 |
|
|
} |
956 |
|
|
return false; |
957 |
|
|
} |
958 |
|
|
|
959 |
|
|
public long estimateSize() { return (long)(getFence() - index); } |
960 |
|
|
|
961 |
|
|
public int characteristics() { |
962 |
|
|
return Spliterator.NONNULL | Spliterator.SIZED | Spliterator.SUBSIZED; |
963 |
|
|
} |
964 |
|
|
} |
965 |
|
|
|
966 |
jsr166 |
1.102 |
/** |
967 |
|
|
* Returns a {@link Spliterator} over the elements in this queue. |
968 |
|
|
* |
969 |
jsr166 |
1.103 |
* <p>The returned spliterator is |
970 |
|
|
* <a href="package-summary.html#Weakly"><i>weakly consistent</i></a>. |
971 |
|
|
* |
972 |
jsr166 |
1.102 |
* <p>The {@code Spliterator} reports {@link Spliterator#SIZED} and |
973 |
|
|
* {@link Spliterator#NONNULL}. |
974 |
|
|
* |
975 |
|
|
* @implNote |
976 |
|
|
* The {@code Spliterator} additionally reports {@link Spliterator#SUBSIZED}. |
977 |
|
|
* |
978 |
|
|
* @return a {@code Spliterator} over the elements in this queue |
979 |
|
|
* @since 1.8 |
980 |
|
|
*/ |
981 |
dl |
1.94 |
public Spliterator<E> spliterator() { |
982 |
dl |
1.93 |
return new PBQSpliterator<E>(this, null, 0, -1); |
983 |
dl |
1.86 |
} |
984 |
|
|
|
985 |
dl |
1.115 |
// VarHandle mechanics |
986 |
|
|
private static final VarHandle ALLOCATIONSPINLOCK; |
987 |
dl |
1.70 |
static { |
988 |
dl |
1.59 |
try { |
989 |
dl |
1.115 |
MethodHandles.Lookup l = MethodHandles.lookup(); |
990 |
|
|
ALLOCATIONSPINLOCK = l.findVarHandle(PriorityBlockingQueue.class, |
991 |
|
|
"allocationSpinLock", |
992 |
|
|
int.class); |
993 |
jsr166 |
1.107 |
} catch (ReflectiveOperationException e) { |
994 |
dl |
1.70 |
throw new Error(e); |
995 |
dl |
1.59 |
} |
996 |
|
|
} |
997 |
tim |
1.1 |
} |