1 |
|
/* |
2 |
< |
* %W% %E% |
2 |
> |
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
3 |
> |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
|
* |
5 |
< |
* Copyright 2006 Sun Microsystems, Inc. All rights reserved. |
6 |
< |
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. |
5 |
> |
* This code is free software; you can redistribute it and/or modify it |
6 |
> |
* under the terms of the GNU General Public License version 2 only, as |
7 |
> |
* published by the Free Software Foundation. Oracle designates this |
8 |
> |
* particular file as subject to the "Classpath" exception as provided |
9 |
> |
* by Oracle in the LICENSE file that accompanied this code. |
10 |
> |
* |
11 |
> |
* This code is distributed in the hope that it will be useful, but WITHOUT |
12 |
> |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
13 |
> |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
14 |
> |
* version 2 for more details (a copy is included in the LICENSE file that |
15 |
> |
* accompanied this code). |
16 |
> |
* |
17 |
> |
* You should have received a copy of the GNU General Public License version |
18 |
> |
* 2 along with this work; if not, write to the Free Software Foundation, |
19 |
> |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
20 |
> |
* |
21 |
> |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
> |
* or visit www.oracle.com if you need additional information or have any |
23 |
> |
* questions. |
24 |
|
*/ |
25 |
|
|
26 |
|
package java.util; |
27 |
|
|
28 |
+ |
import java.util.function.Consumer; |
29 |
+ |
|
30 |
|
/** |
31 |
|
* An unbounded priority {@linkplain Queue queue} based on a priority heap. |
32 |
|
* The elements of the priority queue are ordered according to their |
54 |
|
* <p>This class and its iterator implement all of the |
55 |
|
* <em>optional</em> methods of the {@link Collection} and {@link |
56 |
|
* Iterator} interfaces. The Iterator provided in method {@link |
57 |
< |
* #iterator()} is <em>not</em> guaranteed to traverse the elements of |
57 |
> |
* #iterator()} and the Spliterator provided in method {@link #spliterator()} |
58 |
> |
* are <em>not</em> guaranteed to traverse the elements of |
59 |
|
* the priority queue in any particular order. If you need ordered |
60 |
|
* traversal, consider using {@code Arrays.sort(pq.toArray())}. |
61 |
|
* |
62 |
< |
* <p> <strong>Note that this implementation is not synchronized.</strong> |
62 |
> |
* <p><strong>Note that this implementation is not synchronized.</strong> |
63 |
|
* Multiple threads should not access a {@code PriorityQueue} |
64 |
|
* instance concurrently if any of the threads modifies the queue. |
65 |
|
* Instead, use the thread-safe {@link |
66 |
|
* java.util.concurrent.PriorityBlockingQueue} class. |
67 |
|
* |
68 |
|
* <p>Implementation note: this implementation provides |
69 |
< |
* O(log(n)) time for the enqueing and dequeing methods |
69 |
> |
* O(log(n)) time for the enqueuing and dequeuing methods |
70 |
|
* ({@code offer}, {@code poll}, {@code remove()} and {@code add}); |
71 |
|
* linear time for the {@code remove(Object)} and {@code contains(Object)} |
72 |
|
* methods; and constant time for the retrieval methods |
73 |
|
* ({@code peek}, {@code element}, and {@code size}). |
74 |
|
* |
75 |
|
* <p>This class is a member of the |
76 |
< |
* <a href="{@docRoot}/../guide/collections/index.html"> |
76 |
> |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
77 |
|
* Java Collections Framework</a>. |
78 |
|
* |
79 |
|
* @since 1.5 |
59 |
– |
* @version %I%, %G% |
80 |
|
* @author Josh Bloch, Doug Lea |
81 |
< |
* @param <E> the type of elements held in this collection |
81 |
> |
* @param <E> the type of elements held in this queue |
82 |
|
*/ |
83 |
|
public class PriorityQueue<E> extends AbstractQueue<E> |
84 |
|
implements java.io.Serializable { |
95 |
|
* heap and each descendant d of n, n <= d. The element with the |
96 |
|
* lowest value is in queue[0], assuming the queue is nonempty. |
97 |
|
*/ |
98 |
< |
private transient Object[] queue; |
98 |
> |
transient Object[] queue; // non-private to simplify nested class access |
99 |
|
|
100 |
|
/** |
101 |
|
* The number of elements in the priority queue. |
102 |
|
*/ |
103 |
< |
private int size = 0; |
103 |
> |
int size; |
104 |
|
|
105 |
|
/** |
106 |
|
* The comparator, or null if priority queue uses elements' |
112 |
|
* The number of times this priority queue has been |
113 |
|
* <i>structurally modified</i>. See AbstractList for gory details. |
114 |
|
*/ |
115 |
< |
private transient int modCount = 0; |
115 |
> |
transient int modCount; // non-private to simplify nested class access |
116 |
|
|
117 |
|
/** |
118 |
|
* Creates a {@code PriorityQueue} with the default initial |
137 |
|
} |
138 |
|
|
139 |
|
/** |
140 |
+ |
* Creates a {@code PriorityQueue} with the default initial capacity and |
141 |
+ |
* whose elements are ordered according to the specified comparator. |
142 |
+ |
* |
143 |
+ |
* @param comparator the comparator that will be used to order this |
144 |
+ |
* priority queue. If {@code null}, the {@linkplain Comparable |
145 |
+ |
* natural ordering} of the elements will be used. |
146 |
+ |
* @since 1.8 |
147 |
+ |
*/ |
148 |
+ |
public PriorityQueue(Comparator<? super E> comparator) { |
149 |
+ |
this(DEFAULT_INITIAL_CAPACITY, comparator); |
150 |
+ |
} |
151 |
+ |
|
152 |
+ |
/** |
153 |
|
* Creates a {@code PriorityQueue} with the specified initial capacity |
154 |
|
* that orders its elements according to the specified comparator. |
155 |
|
* |
186 |
|
* @throws NullPointerException if the specified collection or any |
187 |
|
* of its elements are null |
188 |
|
*/ |
189 |
+ |
@SuppressWarnings("unchecked") |
190 |
|
public PriorityQueue(Collection<? extends E> c) { |
191 |
< |
initFromCollection(c); |
192 |
< |
if (c instanceof SortedSet) |
193 |
< |
comparator = (Comparator<? super E>) |
194 |
< |
((SortedSet<? extends E>)c).comparator(); |
195 |
< |
else if (c instanceof PriorityQueue) |
196 |
< |
comparator = (Comparator<? super E>) |
197 |
< |
((PriorityQueue<? extends E>)c).comparator(); |
191 |
> |
if (c instanceof SortedSet<?>) { |
192 |
> |
SortedSet<? extends E> ss = (SortedSet<? extends E>) c; |
193 |
> |
this.comparator = (Comparator<? super E>) ss.comparator(); |
194 |
> |
initElementsFromCollection(ss); |
195 |
> |
} |
196 |
> |
else if (c instanceof PriorityQueue<?>) { |
197 |
> |
PriorityQueue<? extends E> pq = (PriorityQueue<? extends E>) c; |
198 |
> |
this.comparator = (Comparator<? super E>) pq.comparator(); |
199 |
> |
initFromPriorityQueue(pq); |
200 |
> |
} |
201 |
|
else { |
202 |
< |
comparator = null; |
203 |
< |
heapify(); |
202 |
> |
this.comparator = null; |
203 |
> |
initFromCollection(c); |
204 |
|
} |
205 |
|
} |
206 |
|
|
218 |
|
* @throws NullPointerException if the specified priority queue or any |
219 |
|
* of its elements are null |
220 |
|
*/ |
221 |
+ |
@SuppressWarnings("unchecked") |
222 |
|
public PriorityQueue(PriorityQueue<? extends E> c) { |
223 |
< |
comparator = (Comparator<? super E>)c.comparator(); |
224 |
< |
initFromCollection(c); |
223 |
> |
this.comparator = (Comparator<? super E>) c.comparator(); |
224 |
> |
initFromPriorityQueue(c); |
225 |
|
} |
226 |
|
|
227 |
|
/** |
237 |
|
* @throws NullPointerException if the specified sorted set or any |
238 |
|
* of its elements are null |
239 |
|
*/ |
240 |
+ |
@SuppressWarnings("unchecked") |
241 |
|
public PriorityQueue(SortedSet<? extends E> c) { |
242 |
< |
comparator = (Comparator<? super E>)c.comparator(); |
243 |
< |
initFromCollection(c); |
242 |
> |
this.comparator = (Comparator<? super E>) c.comparator(); |
243 |
> |
initElementsFromCollection(c); |
244 |
> |
} |
245 |
> |
|
246 |
> |
private void initFromPriorityQueue(PriorityQueue<? extends E> c) { |
247 |
> |
if (c.getClass() == PriorityQueue.class) { |
248 |
> |
this.queue = c.toArray(); |
249 |
> |
this.size = c.size(); |
250 |
> |
} else { |
251 |
> |
initFromCollection(c); |
252 |
> |
} |
253 |
> |
} |
254 |
> |
|
255 |
> |
private void initElementsFromCollection(Collection<? extends E> c) { |
256 |
> |
Object[] a = c.toArray(); |
257 |
> |
// If c.toArray incorrectly doesn't return Object[], copy it. |
258 |
> |
if (a.getClass() != Object[].class) |
259 |
> |
a = Arrays.copyOf(a, a.length, Object[].class); |
260 |
> |
int len = a.length; |
261 |
> |
if (len == 1 || this.comparator != null) |
262 |
> |
for (Object e : a) |
263 |
> |
if (e == null) |
264 |
> |
throw new NullPointerException(); |
265 |
> |
this.queue = a; |
266 |
> |
this.size = a.length; |
267 |
|
} |
268 |
|
|
269 |
|
/** |
272 |
|
* @param c the collection |
273 |
|
*/ |
274 |
|
private void initFromCollection(Collection<? extends E> c) { |
275 |
< |
Object[] a = c.toArray(); |
276 |
< |
// If c.toArray incorrectly doesn't return Object[], copy it. |
215 |
< |
if (a.getClass() != Object[].class) |
216 |
< |
a = Arrays.copyOf(a, a.length, Object[].class); |
217 |
< |
queue = a; |
218 |
< |
size = a.length; |
275 |
> |
initElementsFromCollection(c); |
276 |
> |
heapify(); |
277 |
|
} |
278 |
|
|
279 |
|
/** |
280 |
+ |
* The maximum size of array to allocate. |
281 |
+ |
* Some VMs reserve some header words in an array. |
282 |
+ |
* Attempts to allocate larger arrays may result in |
283 |
+ |
* OutOfMemoryError: Requested array size exceeds VM limit |
284 |
+ |
*/ |
285 |
+ |
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; |
286 |
+ |
|
287 |
+ |
/** |
288 |
|
* Increases the capacity of the array. |
289 |
|
* |
290 |
|
* @param minCapacity the desired minimum capacity |
291 |
|
*/ |
292 |
|
private void grow(int minCapacity) { |
293 |
< |
if (minCapacity < 0) // overflow |
228 |
< |
throw new OutOfMemoryError(); |
229 |
< |
int oldCapacity = queue.length; |
293 |
> |
int oldCapacity = queue.length; |
294 |
|
// Double size if small; else grow by 50% |
295 |
< |
int newCapacity = ((oldCapacity < 64)? |
296 |
< |
((oldCapacity + 1) * 2): |
297 |
< |
((oldCapacity / 2) * 3)); |
298 |
< |
if (newCapacity < 0) // overflow |
299 |
< |
newCapacity = Integer.MAX_VALUE; |
300 |
< |
if (newCapacity < minCapacity) |
237 |
< |
newCapacity = minCapacity; |
295 |
> |
int newCapacity = oldCapacity + ((oldCapacity < 64) ? |
296 |
> |
(oldCapacity + 2) : |
297 |
> |
(oldCapacity >> 1)); |
298 |
> |
// overflow-conscious code |
299 |
> |
if (newCapacity - MAX_ARRAY_SIZE > 0) |
300 |
> |
newCapacity = hugeCapacity(minCapacity); |
301 |
|
queue = Arrays.copyOf(queue, newCapacity); |
302 |
|
} |
303 |
|
|
304 |
+ |
private static int hugeCapacity(int minCapacity) { |
305 |
+ |
if (minCapacity < 0) // overflow |
306 |
+ |
throw new OutOfMemoryError(); |
307 |
+ |
return (minCapacity > MAX_ARRAY_SIZE) ? |
308 |
+ |
Integer.MAX_VALUE : |
309 |
+ |
MAX_ARRAY_SIZE; |
310 |
+ |
} |
311 |
+ |
|
312 |
|
/** |
313 |
|
* Inserts the specified element into this priority queue. |
314 |
|
* |
338 |
|
int i = size; |
339 |
|
if (i >= queue.length) |
340 |
|
grow(i + 1); |
341 |
+ |
siftUp(i, e); |
342 |
|
size = i + 1; |
271 |
– |
if (i == 0) |
272 |
– |
queue[0] = e; |
273 |
– |
else |
274 |
– |
siftUp(i, e); |
343 |
|
return true; |
344 |
|
} |
345 |
|
|
346 |
+ |
@SuppressWarnings("unchecked") |
347 |
|
public E peek() { |
348 |
< |
if (size == 0) |
280 |
< |
return null; |
281 |
< |
return (E) queue[0]; |
348 |
> |
return (size == 0) ? null : (E) queue[0]; |
349 |
|
} |
350 |
|
|
351 |
|
private int indexOf(Object o) { |
352 |
< |
if (o != null) { |
352 |
> |
if (o != null) { |
353 |
|
for (int i = 0; i < size; i++) |
354 |
|
if (o.equals(queue[i])) |
355 |
|
return i; |
369 |
|
* @return {@code true} if this queue changed as a result of the call |
370 |
|
*/ |
371 |
|
public boolean remove(Object o) { |
372 |
< |
int i = indexOf(o); |
373 |
< |
if (i == -1) |
374 |
< |
return false; |
375 |
< |
else { |
376 |
< |
removeAt(i); |
377 |
< |
return true; |
378 |
< |
} |
372 |
> |
int i = indexOf(o); |
373 |
> |
if (i == -1) |
374 |
> |
return false; |
375 |
> |
else { |
376 |
> |
removeAt(i); |
377 |
> |
return true; |
378 |
> |
} |
379 |
|
} |
380 |
|
|
381 |
|
/** |
386 |
|
* @return {@code true} if removed |
387 |
|
*/ |
388 |
|
boolean removeEq(Object o) { |
389 |
< |
for (int i = 0; i < size; i++) { |
390 |
< |
if (o == queue[i]) { |
389 |
> |
for (int i = 0; i < size; i++) { |
390 |
> |
if (o == queue[i]) { |
391 |
|
removeAt(i); |
392 |
|
return true; |
393 |
|
} |
404 |
|
* @return {@code true} if this queue contains the specified element |
405 |
|
*/ |
406 |
|
public boolean contains(Object o) { |
407 |
< |
return indexOf(o) != -1; |
407 |
> |
return indexOf(o) >= 0; |
408 |
|
} |
409 |
|
|
410 |
|
/** |
442 |
|
* precise control over the runtime type of the output array, and may, |
443 |
|
* under certain circumstances, be used to save allocation costs. |
444 |
|
* |
445 |
< |
* <p>Suppose <tt>x</tt> is a queue known to contain only strings. |
445 |
> |
* <p>Suppose {@code x} is a queue known to contain only strings. |
446 |
|
* The following code can be used to dump the queue into a newly |
447 |
< |
* allocated array of <tt>String</tt>: |
447 |
> |
* allocated array of {@code String}: |
448 |
|
* |
449 |
< |
* <pre> |
383 |
< |
* String[] y = x.toArray(new String[0]);</pre> |
449 |
> |
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre> |
450 |
|
* |
451 |
< |
* Note that <tt>toArray(new Object[0])</tt> is identical in function to |
452 |
< |
* <tt>toArray()</tt>. |
451 |
> |
* Note that {@code toArray(new Object[0])} is identical in function to |
452 |
> |
* {@code toArray()}. |
453 |
|
* |
454 |
|
* @param a the array into which the elements of the queue are to |
455 |
|
* be stored, if it is big enough; otherwise, a new array of the |
460 |
|
* this queue |
461 |
|
* @throws NullPointerException if the specified array is null |
462 |
|
*/ |
463 |
+ |
@SuppressWarnings("unchecked") |
464 |
|
public <T> T[] toArray(T[] a) { |
465 |
+ |
final int size = this.size; |
466 |
|
if (a.length < size) |
467 |
|
// Make a new array of a's runtime type, but my contents: |
468 |
|
return (T[]) Arrays.copyOf(queue, size, a.getClass()); |
469 |
< |
System.arraycopy(queue, 0, a, 0, size); |
469 |
> |
System.arraycopy(queue, 0, a, 0, size); |
470 |
|
if (a.length > size) |
471 |
|
a[size] = null; |
472 |
|
return a; |
487 |
|
* Index (into queue array) of element to be returned by |
488 |
|
* subsequent call to next. |
489 |
|
*/ |
490 |
< |
private int cursor = 0; |
490 |
> |
private int cursor; |
491 |
|
|
492 |
|
/** |
493 |
|
* Index of element returned by most recent call to next, |
507 |
|
* We expect that most iterations, even those involving removals, |
508 |
|
* will not need to store elements in this field. |
509 |
|
*/ |
510 |
< |
private ArrayDeque<E> forgetMeNot = null; |
510 |
> |
private ArrayDeque<E> forgetMeNot; |
511 |
|
|
512 |
|
/** |
513 |
|
* Element returned by the most recent call to next iff that |
514 |
|
* element was drawn from the forgetMeNot list. |
515 |
|
*/ |
516 |
< |
private E lastRetElt = null; |
516 |
> |
private E lastRetElt; |
517 |
|
|
518 |
|
/** |
519 |
|
* The modCount value that the iterator believes that the backing |
527 |
|
(forgetMeNot != null && !forgetMeNot.isEmpty()); |
528 |
|
} |
529 |
|
|
530 |
+ |
@SuppressWarnings("unchecked") |
531 |
|
public E next() { |
532 |
|
if (expectedModCount != modCount) |
533 |
|
throw new ConcurrentModificationException(); |
552 |
|
cursor--; |
553 |
|
else { |
554 |
|
if (forgetMeNot == null) |
555 |
< |
forgetMeNot = new ArrayDeque<E>(); |
555 |
> |
forgetMeNot = new ArrayDeque<>(); |
556 |
|
forgetMeNot.add(moved); |
557 |
|
} |
558 |
|
} else if (lastRetElt != null) { |
560 |
|
lastRetElt = null; |
561 |
|
} else { |
562 |
|
throw new IllegalStateException(); |
563 |
< |
} |
563 |
> |
} |
564 |
|
expectedModCount = modCount; |
565 |
|
} |
566 |
|
} |
580 |
|
size = 0; |
581 |
|
} |
582 |
|
|
583 |
+ |
@SuppressWarnings("unchecked") |
584 |
|
public E poll() { |
585 |
|
if (size == 0) |
586 |
|
return null; |
606 |
|
* position before i. This fact is used by iterator.remove so as to |
607 |
|
* avoid missing traversing elements. |
608 |
|
*/ |
609 |
< |
private E removeAt(int i) { |
610 |
< |
assert i >= 0 && i < size; |
609 |
> |
@SuppressWarnings("unchecked") |
610 |
> |
E removeAt(int i) { |
611 |
> |
// assert i >= 0 && i < size; |
612 |
|
modCount++; |
613 |
|
int s = --size; |
614 |
|
if (s == i) // removed last element |
645 |
|
siftUpComparable(k, x); |
646 |
|
} |
647 |
|
|
648 |
+ |
@SuppressWarnings("unchecked") |
649 |
|
private void siftUpComparable(int k, E x) { |
650 |
|
Comparable<? super E> key = (Comparable<? super E>) x; |
651 |
|
while (k > 0) { |
659 |
|
queue[k] = key; |
660 |
|
} |
661 |
|
|
662 |
+ |
@SuppressWarnings("unchecked") |
663 |
|
private void siftUpUsingComparator(int k, E x) { |
664 |
|
while (k > 0) { |
665 |
|
int parent = (k - 1) >>> 1; |
687 |
|
siftDownComparable(k, x); |
688 |
|
} |
689 |
|
|
690 |
+ |
@SuppressWarnings("unchecked") |
691 |
|
private void siftDownComparable(int k, E x) { |
692 |
|
Comparable<? super E> key = (Comparable<? super E>)x; |
693 |
|
int half = size >>> 1; // loop while a non-leaf |
706 |
|
queue[k] = key; |
707 |
|
} |
708 |
|
|
709 |
+ |
@SuppressWarnings("unchecked") |
710 |
|
private void siftDownUsingComparator(int k, E x) { |
711 |
|
int half = size >>> 1; |
712 |
|
while (k < half) { |
728 |
|
* Establishes the heap invariant (described above) in the entire tree, |
729 |
|
* assuming nothing about the order of the elements prior to the call. |
730 |
|
*/ |
731 |
+ |
@SuppressWarnings("unchecked") |
732 |
|
private void heapify() { |
733 |
|
for (int i = (size >>> 1) - 1; i >= 0; i--) |
734 |
|
siftDown(i, (E) queue[i]); |
748 |
|
} |
749 |
|
|
750 |
|
/** |
751 |
< |
* Saves the state of the instance to a stream (that |
676 |
< |
* is, serializes it). |
751 |
> |
* Saves this queue to a stream (that is, serializes it). |
752 |
|
* |
753 |
+ |
* @param s the stream |
754 |
+ |
* @throws java.io.IOException if an I/O error occurs |
755 |
|
* @serialData The length of the array backing the instance is |
756 |
|
* emitted (int), followed by all of its elements |
757 |
|
* (each an {@code Object}) in the proper order. |
681 |
– |
* @param s the stream |
758 |
|
*/ |
759 |
|
private void writeObject(java.io.ObjectOutputStream s) |
760 |
< |
throws java.io.IOException{ |
760 |
> |
throws java.io.IOException { |
761 |
|
// Write out element count, and any hidden stuff |
762 |
|
s.defaultWriteObject(); |
763 |
|
|
764 |
|
// Write out array length, for compatibility with 1.5 version |
765 |
|
s.writeInt(Math.max(2, size + 1)); |
766 |
|
|
767 |
< |
// Write out all elements in the proper order. |
767 |
> |
// Write out all elements in the "proper order". |
768 |
|
for (int i = 0; i < size; i++) |
769 |
|
s.writeObject(queue[i]); |
770 |
|
} |
774 |
|
* (that is, deserializes it). |
775 |
|
* |
776 |
|
* @param s the stream |
777 |
+ |
* @throws ClassNotFoundException if the class of a serialized object |
778 |
+ |
* could not be found |
779 |
+ |
* @throws java.io.IOException if an I/O error occurs |
780 |
|
*/ |
781 |
|
private void readObject(java.io.ObjectInputStream s) |
782 |
|
throws java.io.IOException, ClassNotFoundException { |
786 |
|
// Read in (and discard) array length |
787 |
|
s.readInt(); |
788 |
|
|
789 |
< |
queue = new Object[size]; |
789 |
> |
queue = new Object[size]; |
790 |
|
|
791 |
< |
// Read in all elements in the proper order. |
791 |
> |
// Read in all elements. |
792 |
|
for (int i = 0; i < size; i++) |
793 |
|
queue[i] = s.readObject(); |
794 |
+ |
|
795 |
+ |
// Elements are guaranteed to be in "proper order", but the |
796 |
+ |
// spec has never explained what that might be. |
797 |
+ |
heapify(); |
798 |
+ |
} |
799 |
+ |
|
800 |
+ |
/** |
801 |
+ |
* Creates a <em><a href="Spliterator.html#binding">late-binding</a></em> |
802 |
+ |
* and <em>fail-fast</em> {@link Spliterator} over the elements in this |
803 |
+ |
* queue. The spliterator does not traverse elements in any particular order |
804 |
+ |
* (the {@link Spliterator#ORDERED ORDERED} characteristic is not reported). |
805 |
+ |
* |
806 |
+ |
* <p>The {@code Spliterator} reports {@link Spliterator#SIZED}, |
807 |
+ |
* {@link Spliterator#SUBSIZED}, and {@link Spliterator#NONNULL}. |
808 |
+ |
* Overriding implementations should document the reporting of additional |
809 |
+ |
* characteristic values. |
810 |
+ |
* |
811 |
+ |
* @return a {@code Spliterator} over the elements in this queue |
812 |
+ |
* @since 1.8 |
813 |
+ |
*/ |
814 |
+ |
public final Spliterator<E> spliterator() { |
815 |
+ |
return new PriorityQueueSpliterator<>(this, 0, -1, 0); |
816 |
+ |
} |
817 |
+ |
|
818 |
+ |
static final class PriorityQueueSpliterator<E> implements Spliterator<E> { |
819 |
+ |
/* |
820 |
+ |
* This is very similar to ArrayList Spliterator, except for |
821 |
+ |
* extra null checks. |
822 |
+ |
*/ |
823 |
+ |
private final PriorityQueue<E> pq; |
824 |
+ |
private int index; // current index, modified on advance/split |
825 |
+ |
private int fence; // -1 until first use |
826 |
+ |
private int expectedModCount; // initialized when fence set |
827 |
+ |
|
828 |
+ |
/** Creates new spliterator covering the given range. */ |
829 |
+ |
PriorityQueueSpliterator(PriorityQueue<E> pq, int origin, int fence, |
830 |
+ |
int expectedModCount) { |
831 |
+ |
this.pq = pq; |
832 |
+ |
this.index = origin; |
833 |
+ |
this.fence = fence; |
834 |
+ |
this.expectedModCount = expectedModCount; |
835 |
+ |
} |
836 |
+ |
|
837 |
+ |
private int getFence() { // initialize fence to size on first use |
838 |
+ |
int hi; |
839 |
+ |
if ((hi = fence) < 0) { |
840 |
+ |
expectedModCount = pq.modCount; |
841 |
+ |
hi = fence = pq.size; |
842 |
+ |
} |
843 |
+ |
return hi; |
844 |
+ |
} |
845 |
+ |
|
846 |
+ |
public PriorityQueueSpliterator<E> trySplit() { |
847 |
+ |
int hi = getFence(), lo = index, mid = (lo + hi) >>> 1; |
848 |
+ |
return (lo >= mid) ? null : |
849 |
+ |
new PriorityQueueSpliterator<>(pq, lo, index = mid, |
850 |
+ |
expectedModCount); |
851 |
+ |
} |
852 |
+ |
|
853 |
+ |
@SuppressWarnings("unchecked") |
854 |
+ |
public void forEachRemaining(Consumer<? super E> action) { |
855 |
+ |
int i, hi, mc; // hoist accesses and checks from loop |
856 |
+ |
PriorityQueue<E> q; Object[] a; |
857 |
+ |
if (action == null) |
858 |
+ |
throw new NullPointerException(); |
859 |
+ |
if ((q = pq) != null && (a = q.queue) != null) { |
860 |
+ |
if ((hi = fence) < 0) { |
861 |
+ |
mc = q.modCount; |
862 |
+ |
hi = q.size; |
863 |
+ |
} |
864 |
+ |
else |
865 |
+ |
mc = expectedModCount; |
866 |
+ |
if ((i = index) >= 0 && (index = hi) <= a.length) { |
867 |
+ |
for (E e;; ++i) { |
868 |
+ |
if (i < hi) { |
869 |
+ |
if ((e = (E) a[i]) == null) // must be CME |
870 |
+ |
break; |
871 |
+ |
action.accept(e); |
872 |
+ |
} |
873 |
+ |
else if (q.modCount != mc) |
874 |
+ |
break; |
875 |
+ |
else |
876 |
+ |
return; |
877 |
+ |
} |
878 |
+ |
} |
879 |
+ |
} |
880 |
+ |
throw new ConcurrentModificationException(); |
881 |
+ |
} |
882 |
+ |
|
883 |
+ |
public boolean tryAdvance(Consumer<? super E> action) { |
884 |
+ |
if (action == null) |
885 |
+ |
throw new NullPointerException(); |
886 |
+ |
int hi = getFence(), lo = index; |
887 |
+ |
if (lo >= 0 && lo < hi) { |
888 |
+ |
index = lo + 1; |
889 |
+ |
@SuppressWarnings("unchecked") E e = (E)pq.queue[lo]; |
890 |
+ |
if (e == null) |
891 |
+ |
throw new ConcurrentModificationException(); |
892 |
+ |
action.accept(e); |
893 |
+ |
if (pq.modCount != expectedModCount) |
894 |
+ |
throw new ConcurrentModificationException(); |
895 |
+ |
return true; |
896 |
+ |
} |
897 |
+ |
return false; |
898 |
+ |
} |
899 |
+ |
|
900 |
+ |
public long estimateSize() { |
901 |
+ |
return (long) (getFence() - index); |
902 |
+ |
} |
903 |
+ |
|
904 |
+ |
public int characteristics() { |
905 |
+ |
return Spliterator.SIZED | Spliterator.SUBSIZED | Spliterator.NONNULL; |
906 |
+ |
} |
907 |
|
} |
908 |
|
} |