| 1 |
|
/* |
| 2 |
< |
* Written by Doug Lea with assistance from members of JCP JSR-166 |
| 3 |
< |
* Expert Group and released to the public domain, as explained at |
| 4 |
< |
* http://creativecommons.org/publicdomain/zero/1.0/ |
| 2 |
> |
* Written by Josh Bloch of Google Inc. and released to the public domain, |
| 3 |
> |
* as explained at http://creativecommons.org/publicdomain/zero/1.0/. |
| 4 |
|
*/ |
| 5 |
|
|
| 6 |
|
package java.util; |
| 7 |
< |
import java.util.Spliterator; |
| 8 |
< |
import java.util.stream.Stream; |
| 10 |
< |
import java.util.stream.Streams; |
| 7 |
> |
|
| 8 |
> |
import java.io.Serializable; |
| 9 |
|
import java.util.function.Consumer; |
| 10 |
|
|
| 11 |
|
/** |
| 18 |
|
* when used as a queue. |
| 19 |
|
* |
| 20 |
|
* <p>Most {@code ArrayDeque} operations run in amortized constant time. |
| 21 |
< |
* Exceptions include {@link #remove(Object) remove}, {@link |
| 22 |
< |
* #removeFirstOccurrence removeFirstOccurrence}, {@link #removeLastOccurrence |
| 23 |
< |
* removeLastOccurrence}, {@link #contains contains}, {@link #iterator |
| 24 |
< |
* iterator.remove()}, and the bulk operations, all of which run in linear |
| 25 |
< |
* time. |
| 21 |
> |
* Exceptions include |
| 22 |
> |
* {@link #remove(Object) remove}, |
| 23 |
> |
* {@link #removeFirstOccurrence removeFirstOccurrence}, |
| 24 |
> |
* {@link #removeLastOccurrence removeLastOccurrence}, |
| 25 |
> |
* {@link #contains contains}, |
| 26 |
> |
* {@link #iterator iterator.remove()}, |
| 27 |
> |
* and the bulk operations, all of which run in linear time. |
| 28 |
|
* |
| 29 |
< |
* <p>The iterators returned by this class's {@code iterator} method are |
| 30 |
< |
* <i>fail-fast</i>: If the deque is modified at any time after the iterator |
| 31 |
< |
* is created, in any way except through the iterator's own {@code remove} |
| 32 |
< |
* method, the iterator will generally throw a {@link |
| 29 |
> |
* <p>The iterators returned by this class's {@link #iterator() iterator} |
| 30 |
> |
* method are <em>fail-fast</em>: If the deque is modified at any time after |
| 31 |
> |
* the iterator is created, in any way except through the iterator's own |
| 32 |
> |
* {@code remove} method, the iterator will generally throw a {@link |
| 33 |
|
* ConcurrentModificationException}. Thus, in the face of concurrent |
| 34 |
|
* modification, the iterator fails quickly and cleanly, rather than risking |
| 35 |
|
* arbitrary, non-deterministic behavior at an undetermined time in the |
| 53 |
|
* |
| 54 |
|
* @author Josh Bloch and Doug Lea |
| 55 |
|
* @since 1.6 |
| 56 |
< |
* @param <E> the type of elements held in this collection |
| 56 |
> |
* @param <E> the type of elements held in this deque |
| 57 |
|
*/ |
| 58 |
|
public class ArrayDeque<E> extends AbstractCollection<E> |
| 59 |
< |
implements Deque<E>, Cloneable, java.io.Serializable |
| 59 |
> |
implements Deque<E>, Cloneable, Serializable |
| 60 |
|
{ |
| 61 |
|
/** |
| 62 |
|
* The array in which the elements of the deque are stored. |
| 136 |
|
} |
| 137 |
|
|
| 138 |
|
/** |
| 139 |
– |
* Copies the elements from our element array into the specified array, |
| 140 |
– |
* in order (from first to last element in the deque). It is assumed |
| 141 |
– |
* that the array is large enough to hold all elements in the deque. |
| 142 |
– |
* |
| 143 |
– |
* @return its argument |
| 144 |
– |
*/ |
| 145 |
– |
private <T> T[] copyElements(T[] a) { |
| 146 |
– |
if (head < tail) { |
| 147 |
– |
System.arraycopy(elements, head, a, 0, size()); |
| 148 |
– |
} else if (head > tail) { |
| 149 |
– |
int headPortionLen = elements.length - head; |
| 150 |
– |
System.arraycopy(elements, head, a, 0, headPortionLen); |
| 151 |
– |
System.arraycopy(elements, 0, a, headPortionLen, tail); |
| 152 |
– |
} |
| 153 |
– |
return a; |
| 154 |
– |
} |
| 155 |
– |
|
| 156 |
– |
/** |
| 139 |
|
* Constructs an empty array deque with an initial capacity |
| 140 |
|
* sufficient to hold 16 elements. |
| 141 |
|
*/ |
| 315 |
|
* @return {@code true} if the deque contained the specified element |
| 316 |
|
*/ |
| 317 |
|
public boolean removeFirstOccurrence(Object o) { |
| 318 |
< |
if (o == null) |
| 319 |
< |
return false; |
| 320 |
< |
int mask = elements.length - 1; |
| 321 |
< |
int i = head; |
| 322 |
< |
Object x; |
| 323 |
< |
while ( (x = elements[i]) != null) { |
| 324 |
< |
if (o.equals(x)) { |
| 325 |
< |
delete(i); |
| 344 |
< |
return true; |
| 318 |
> |
if (o != null) { |
| 319 |
> |
int mask = elements.length - 1; |
| 320 |
> |
int i = head; |
| 321 |
> |
for (Object x; (x = elements[i]) != null; i = (i + 1) & mask) { |
| 322 |
> |
if (o.equals(x)) { |
| 323 |
> |
delete(i); |
| 324 |
> |
return true; |
| 325 |
> |
} |
| 326 |
|
} |
| 346 |
– |
i = (i + 1) & mask; |
| 327 |
|
} |
| 328 |
|
return false; |
| 329 |
|
} |
| 341 |
|
* @return {@code true} if the deque contained the specified element |
| 342 |
|
*/ |
| 343 |
|
public boolean removeLastOccurrence(Object o) { |
| 344 |
< |
if (o == null) |
| 345 |
< |
return false; |
| 346 |
< |
int mask = elements.length - 1; |
| 347 |
< |
int i = (tail - 1) & mask; |
| 348 |
< |
Object x; |
| 349 |
< |
while ( (x = elements[i]) != null) { |
| 350 |
< |
if (o.equals(x)) { |
| 351 |
< |
delete(i); |
| 372 |
< |
return true; |
| 344 |
> |
if (o != null) { |
| 345 |
> |
int mask = elements.length - 1; |
| 346 |
> |
int i = (tail - 1) & mask; |
| 347 |
> |
for (Object x; (x = elements[i]) != null; i = (i - 1) & mask) { |
| 348 |
> |
if (o.equals(x)) { |
| 349 |
> |
delete(i); |
| 350 |
> |
return true; |
| 351 |
> |
} |
| 352 |
|
} |
| 374 |
– |
i = (i - 1) & mask; |
| 353 |
|
} |
| 354 |
|
return false; |
| 355 |
|
} |
| 608 |
|
} |
| 609 |
|
} |
| 610 |
|
|
| 611 |
+ |
/** |
| 612 |
+ |
* This class is nearly a mirror-image of DeqIterator, using tail |
| 613 |
+ |
* instead of head for initial cursor, and head instead of tail |
| 614 |
+ |
* for fence. |
| 615 |
+ |
*/ |
| 616 |
|
private class DescendingIterator implements Iterator<E> { |
| 634 |
– |
/* |
| 635 |
– |
* This class is nearly a mirror-image of DeqIterator, using |
| 636 |
– |
* tail instead of head for initial cursor, and head instead of |
| 637 |
– |
* tail for fence. |
| 638 |
– |
*/ |
| 617 |
|
private int cursor = tail; |
| 618 |
|
private int fence = head; |
| 619 |
|
private int lastRet = -1; |
| 654 |
|
* @return {@code true} if this deque contains the specified element |
| 655 |
|
*/ |
| 656 |
|
public boolean contains(Object o) { |
| 657 |
< |
if (o == null) |
| 658 |
< |
return false; |
| 659 |
< |
int mask = elements.length - 1; |
| 660 |
< |
int i = head; |
| 661 |
< |
Object x; |
| 662 |
< |
while ( (x = elements[i]) != null) { |
| 663 |
< |
if (o.equals(x)) |
| 686 |
< |
return true; |
| 687 |
< |
i = (i + 1) & mask; |
| 657 |
> |
if (o != null) { |
| 658 |
> |
int mask = elements.length - 1; |
| 659 |
> |
int i = head; |
| 660 |
> |
for (Object x; (x = elements[i]) != null; i = (i + 1) & mask) { |
| 661 |
> |
if (o.equals(x)) |
| 662 |
> |
return true; |
| 663 |
> |
} |
| 664 |
|
} |
| 665 |
|
return false; |
| 666 |
|
} |
| 714 |
|
* @return an array containing all of the elements in this deque |
| 715 |
|
*/ |
| 716 |
|
public Object[] toArray() { |
| 717 |
< |
return copyElements(new Object[size()]); |
| 717 |
> |
final int head = this.head; |
| 718 |
> |
final int tail = this.tail; |
| 719 |
> |
boolean wrap = (tail < head); |
| 720 |
> |
int end = wrap ? tail + elements.length : tail; |
| 721 |
> |
Object[] a = Arrays.copyOfRange(elements, head, end); |
| 722 |
> |
if (wrap) |
| 723 |
> |
System.arraycopy(elements, 0, a, elements.length - head, tail); |
| 724 |
> |
return a; |
| 725 |
|
} |
| 726 |
|
|
| 727 |
|
/** |
| 746 |
|
* The following code can be used to dump the deque into a newly |
| 747 |
|
* allocated array of {@code String}: |
| 748 |
|
* |
| 749 |
< |
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre> |
| 749 |
> |
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre> |
| 750 |
|
* |
| 751 |
|
* Note that {@code toArray(new Object[0])} is identical in function to |
| 752 |
|
* {@code toArray()}. |
| 762 |
|
*/ |
| 763 |
|
@SuppressWarnings("unchecked") |
| 764 |
|
public <T> T[] toArray(T[] a) { |
| 765 |
< |
int size = size(); |
| 766 |
< |
if (a.length < size) |
| 767 |
< |
a = (T[])java.lang.reflect.Array.newInstance( |
| 768 |
< |
a.getClass().getComponentType(), size); |
| 769 |
< |
copyElements(a); |
| 770 |
< |
if (a.length > size) |
| 771 |
< |
a[size] = null; |
| 765 |
> |
final int head = this.head; |
| 766 |
> |
final int tail = this.tail; |
| 767 |
> |
boolean wrap = (tail < head); |
| 768 |
> |
int size = (tail - head) + (wrap ? elements.length : 0); |
| 769 |
> |
int firstLeg = size - (wrap ? tail : 0); |
| 770 |
> |
int len = a.length; |
| 771 |
> |
if (size > len) { |
| 772 |
> |
a = (T[]) Arrays.copyOfRange(elements, head, head + size, |
| 773 |
> |
a.getClass()); |
| 774 |
> |
} else { |
| 775 |
> |
System.arraycopy(elements, head, a, 0, firstLeg); |
| 776 |
> |
if (size < len) |
| 777 |
> |
a[size] = null; |
| 778 |
> |
} |
| 779 |
> |
if (wrap) |
| 780 |
> |
System.arraycopy(elements, 0, a, firstLeg, tail); |
| 781 |
|
return a; |
| 782 |
|
} |
| 783 |
|
|
| 804 |
|
/** |
| 805 |
|
* Saves this deque to a stream (that is, serializes it). |
| 806 |
|
* |
| 807 |
+ |
* @param s the stream |
| 808 |
+ |
* @throws java.io.IOException if an I/O error occurs |
| 809 |
|
* @serialData The current size ({@code int}) of the deque, |
| 810 |
|
* followed by all of its elements (each an object reference) in |
| 811 |
|
* first-to-last order. |
| 825 |
|
|
| 826 |
|
/** |
| 827 |
|
* Reconstitutes this deque from a stream (that is, deserializes it). |
| 828 |
+ |
* @param s the stream |
| 829 |
+ |
* @throws ClassNotFoundException if the class of a serialized object |
| 830 |
+ |
* could not be found |
| 831 |
+ |
* @throws java.io.IOException if an I/O error occurs |
| 832 |
|
*/ |
| 833 |
|
private void readObject(java.io.ObjectInputStream s) |
| 834 |
|
throws java.io.IOException, ClassNotFoundException { |
| 845 |
|
elements[i] = s.readObject(); |
| 846 |
|
} |
| 847 |
|
|
| 848 |
< |
public Stream<E> stream() { |
| 849 |
< |
int flags = Streams.STREAM_IS_ORDERED | Streams.STREAM_IS_SIZED; |
| 852 |
< |
return Streams.stream |
| 853 |
< |
(() -> new DeqSpliterator<E>(this, head, tail), flags); |
| 854 |
< |
} |
| 855 |
< |
public Stream<E> parallelStream() { |
| 856 |
< |
int flags = Streams.STREAM_IS_ORDERED | Streams.STREAM_IS_SIZED; |
| 857 |
< |
return Streams.parallelStream |
| 858 |
< |
(() -> new DeqSpliterator<E>(this, head, tail), flags); |
| 848 |
> |
public Spliterator<E> spliterator() { |
| 849 |
> |
return new DeqSpliterator<E>(this, -1, -1); |
| 850 |
|
} |
| 851 |
|
|
| 861 |
– |
|
| 852 |
|
static final class DeqSpliterator<E> implements Spliterator<E> { |
| 853 |
|
private final ArrayDeque<E> deq; |
| 854 |
< |
private final int fence; // initially tail |
| 855 |
< |
private int index; // current index, modified on traverse/split |
| 854 |
> |
private int fence; // -1 until first use |
| 855 |
> |
private int index; // current index, modified on traverse/split |
| 856 |
|
|
| 857 |
< |
/** Create new spliterator covering the given array and range */ |
| 857 |
> |
/** Creates new spliterator covering the given array and range */ |
| 858 |
|
DeqSpliterator(ArrayDeque<E> deq, int origin, int fence) { |
| 859 |
< |
this.deq = deq; this.index = origin; this.fence = fence; |
| 859 |
> |
this.deq = deq; |
| 860 |
> |
this.index = origin; |
| 861 |
> |
this.fence = fence; |
| 862 |
|
} |
| 863 |
|
|
| 864 |
< |
public DeqSpliterator<E> trySplit() { |
| 865 |
< |
int n = deq.elements.length; |
| 866 |
< |
int h = index, t = fence; |
| 864 |
> |
private int getFence() { // force initialization |
| 865 |
> |
int t; |
| 866 |
> |
if ((t = fence) < 0) { |
| 867 |
> |
t = fence = deq.tail; |
| 868 |
> |
index = deq.head; |
| 869 |
> |
} |
| 870 |
> |
return t; |
| 871 |
> |
} |
| 872 |
> |
|
| 873 |
> |
public Spliterator<E> trySplit() { |
| 874 |
> |
int t = getFence(), h = index, n = deq.elements.length; |
| 875 |
|
if (h != t && ((h + 1) & (n - 1)) != t) { |
| 876 |
|
if (h > t) |
| 877 |
|
t += n; |
| 878 |
|
int m = ((h + t) >>> 1) & (n - 1); |
| 879 |
< |
return new DeqSpliterator<E>(deq, h, index = m); |
| 879 |
> |
return new DeqSpliterator<>(deq, h, index = m); |
| 880 |
|
} |
| 881 |
|
return null; |
| 882 |
|
} |
| 883 |
|
|
| 884 |
< |
public void forEach(Consumer<? super E> block) { |
| 885 |
< |
if (block == null) |
| 884 |
> |
public void forEachRemaining(Consumer<? super E> consumer) { |
| 885 |
> |
if (consumer == null) |
| 886 |
|
throw new NullPointerException(); |
| 887 |
|
Object[] a = deq.elements; |
| 888 |
< |
int m = a.length - 1, f = fence, i = index; |
| 888 |
> |
int m = a.length - 1, f = getFence(), i = index; |
| 889 |
|
index = f; |
| 890 |
|
while (i != f) { |
| 891 |
|
@SuppressWarnings("unchecked") E e = (E)a[i]; |
| 892 |
|
i = (i + 1) & m; |
| 893 |
|
if (e == null) |
| 894 |
|
throw new ConcurrentModificationException(); |
| 895 |
< |
block.accept(e); |
| 895 |
> |
consumer.accept(e); |
| 896 |
|
} |
| 897 |
|
} |
| 898 |
|
|
| 899 |
< |
public boolean tryAdvance(Consumer<? super E> block) { |
| 900 |
< |
if (block == null) |
| 899 |
> |
public boolean tryAdvance(Consumer<? super E> consumer) { |
| 900 |
> |
if (consumer == null) |
| 901 |
|
throw new NullPointerException(); |
| 902 |
|
Object[] a = deq.elements; |
| 903 |
< |
int m = a.length - 1, i = index; |
| 903 |
> |
int m = a.length - 1, f = getFence(), i = index; |
| 904 |
|
if (i != fence) { |
| 905 |
|
@SuppressWarnings("unchecked") E e = (E)a[i]; |
| 906 |
|
index = (i + 1) & m; |
| 907 |
|
if (e == null) |
| 908 |
|
throw new ConcurrentModificationException(); |
| 909 |
< |
block.accept(e); |
| 909 |
> |
consumer.accept(e); |
| 910 |
|
return true; |
| 911 |
|
} |
| 912 |
|
return false; |
| 913 |
|
} |
| 914 |
|
|
| 915 |
– |
// Other spliterator methods |
| 915 |
|
public long estimateSize() { |
| 916 |
< |
int n = fence - index; |
| 916 |
> |
int n = getFence() - index; |
| 917 |
|
if (n < 0) |
| 918 |
|
n += deq.elements.length; |
| 919 |
< |
return (long)n; |
| 919 |
> |
return (long) n; |
| 920 |
> |
} |
| 921 |
> |
|
| 922 |
> |
@Override |
| 923 |
> |
public int characteristics() { |
| 924 |
> |
return Spliterator.ORDERED | Spliterator.SIZED | |
| 925 |
> |
Spliterator.NONNULL | Spliterator.SUBSIZED; |
| 926 |
|
} |
| 922 |
– |
public boolean hasExactSize() { return true; } |
| 923 |
– |
public boolean hasExactSplits() { return true; } |
| 927 |
|
} |
| 928 |
|
|
| 929 |
|
} |
