# ArrayDeque public class **ArrayDeque** extends [AbstractCollection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html)\ implements [Deque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html)\ [Cloneable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Cloneable.html) [Serializable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Serializable.html) Resizable-array implementation of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html` interface. Array deques have no capacity restrictions; they grow as necessary to support usage. They are not thread-safe; in the absence of external synchronization, they do not support concurrent access by multiple threads. Null elements are prohibited. This class is likely to be faster than `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Stack.html` when used as a stack, and faster than `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/LinkedList.html` when used as a queue. Most `ArrayDeque` operations run in amortized constant time. Exceptions include `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#remove(java.lang.Object)`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirstOccurrence(java.lang.Object)`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeLastOccurrence(java.lang.Object)`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#contains(java.lang.Object)`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#iterator()`, and the bulk operations, all of which run in linear time. The iterators returned by this class's `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#iterator()` method are *fail-fast* : If the deque is modified at any time after the iterator is created, in any way except through the iterator's own `remove` method, the iterator will generally throw a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ConcurrentModificationException.html`. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future. Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw `ConcurrentModificationException` on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: *the fail-fast behavior of iterators should be used only to detect bugs.* This class and its iterator implement all of the *optional* methods of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html` interfaces. ### Public Constructor Summary |---|---| | | [ArrayDeque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#ArrayDeque())() Constructs an empty array deque with an initial capacity sufficient to hold 16 elements. | | | [ArrayDeque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#ArrayDeque(int))(int numElements) Constructs an empty array deque with an initial capacity sufficient to hold the specified number of elements. | | | [ArrayDeque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#ArrayDeque(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Constructs a deque containing the elements of the specified collection, in the order they are returned by the collection's iterator. | ### Public Method Summary |---|---| | boolean | [add](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#add(E))(E e) Inserts the specified element at the end of this deque. | | void | [addFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#addFirst(E))(E e) Inserts the specified element at the front of this deque. | | void | [addLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#addLast(E))(E e) Inserts the specified element at the end of this deque. | | void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#clear())() Removes all of the elements from this deque. | | [ArrayDeque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html)\ | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#clone())() Returns a copy of this deque. | | boolean | [contains](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#contains(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Returns `true` if this deque contains the specified element. | | [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [descendingIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#descendingIterator())() Returns an iterator over the elements in this deque in reverse sequential order. | | E | [element](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#element())() Retrieves, but does not remove, the head of the queue represented by this deque. | | E | [getFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#getFirst())() Retrieves, but does not remove, the first element of this deque. | | E | [getLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#getLast())() Retrieves, but does not remove, the last element of this deque. | | boolean | [isEmpty](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#isEmpty())() Returns `true` if this deque contains no elements. | | [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#iterator())() Returns an iterator over the elements in this deque. | | boolean | [offer](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#offer(E))(E e) Inserts the specified element at the end of this deque. | | boolean | [offerFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#offerFirst(E))(E e) Inserts the specified element at the front of this deque. | | boolean | [offerLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#offerLast(E))(E e) Inserts the specified element at the end of this deque. | | E | [peek](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#peek())() Retrieves, but does not remove, the head of the queue represented by this deque, or returns `null` if this deque is empty. | | E | [peekFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#peekFirst())() Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty. | | E | [peekLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#peekLast())() Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty. | | E | [poll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#poll())() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. | | E | [pollFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#pollFirst())() Retrieves and removes the first element of this deque, or returns `null` if this deque is empty. | | E | [pollLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#pollLast())() Retrieves and removes the last element of this deque, or returns `null` if this deque is empty. | | E | [pop](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#pop())() Pops an element from the stack represented by this deque. | | void | [push](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#push(E))(E e) Pushes an element onto the stack represented by this deque. | | E | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#remove())() Retrieves and removes the head of the queue represented by this deque. | | boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes a single instance of the specified element from this deque. | | E | [removeFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirst())() Retrieves and removes the first element of this deque. | | boolean | [removeFirstOccurrence](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirstOccurrence(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the first occurrence of the specified element in this deque (when traversing the deque from head to tail). | | E | [removeLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeLast())() Retrieves and removes the last element of this deque. | | boolean | [removeLastOccurrence](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeLastOccurrence(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the last occurrence of the specified element in this deque (when traversing the deque from head to tail). | | int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#size())() Returns the number of elements in this deque. | | [Spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html)\ | [spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#spliterator())() Creates a *[late-binding](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator#binding)* and *fail-fast* `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html` over the elements in this deque. | | [Object\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#toArray())() Returns an array containing all of the elements in this deque in proper sequence (from first to last element). | | \ T\[\] | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#toArray(T[]))(T\[\] a) Returns an array containing all of the elements in this deque in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. | ### Inherited Method Summary From class [java.util.AbstractCollection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html) |---|---| | boolean | [add](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#add(E))(E e) Ensures that this collection contains the specified element (optional operation). This implementation always throws an UnsupportedOperationException. | | boolean | [addAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#addAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Adds all of the elements in the specified collection to this collection (optional operation). This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn. | | void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#clear())() Removes all of the elements from this collection (optional operation). This implementation iterates over this collection, removing each element using the Iterator.remove operation. | | boolean | [contains](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#contains(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Returns true if this collection contains the specified element. This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element. | | boolean | [containsAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#containsAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Returns true if this collection contains all of the elements in the specified collection. This implementation iterates over the specified collection, checking each element returned by the iterator in turn to see if it's contained in this collection. | | boolean | [isEmpty](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#isEmpty())() Returns true if this collection contains no elements. This implementation returns size() == 0. | | abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#iterator())() Returns an iterator over the elements contained in this collection. | | boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes a single instance of the specified element from this collection, if it is present (optional operation). This implementation iterates over the collection looking for the specified element. | | boolean | [removeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#removeAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Removes all of this collection's elements that are also contained in the specified collection (optional operation). This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. | | boolean | [retainAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#retainAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Retains only the elements in this collection that are contained in the specified collection (optional operation). This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. | | abstract int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#size())() Returns the number of elements in this collection. | | \ T\[\] | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#toArray(T[]))(T\[\] contents) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. This implementation returns an array containing all the elements returned by this collection's iterator in the same order, stored in consecutive elements of the array, starting with index `0`. | | [Object\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#toArray())() Returns an array containing all of the elements in this collection. This implementation returns an array containing all the elements returned by this collection's iterator, in the same order, stored in consecutive elements of the array, starting with index `0`. | | [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractCollection.html#toString())() Returns a string representation of this collection. | From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) |---|---| | [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. | | boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. | | void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. | | final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\ | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. | | int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. | | final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. | | final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. | | [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. | | final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. | | final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. | | final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. | From interface [java.util.Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html) |---|---| | abstract boolean | [add](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#add(E))(E e) Ensures that this collection contains the specified element (optional operation). | | abstract boolean | [addAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#addAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Adds all of the elements in the specified collection to this collection (optional operation). | | abstract void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#clear())() Removes all of the elements from this collection (optional operation). | | abstract boolean | [contains](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#contains(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Returns true if this collection contains the specified element. | | abstract boolean | [containsAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#containsAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Returns true if this collection contains all of the elements in the specified collection. | | abstract boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Compares the specified object with this collection for equality. | | abstract int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#hashCode())() Returns the hash code value for this collection. | | abstract boolean | [isEmpty](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#isEmpty())() Returns true if this collection contains no elements. | | abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#iterator())() Returns an iterator over the elements in this collection. | | [Stream](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/stream/Stream.html)\ | [parallelStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#parallelStream())() Returns a possibly parallel `Stream` with this collection as its source. | | abstract boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes a single instance of the specified element from this collection, if it is present (optional operation). | | abstract boolean | [removeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#removeAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Removes all of this collection's elements that are also contained in the specified collection (optional operation). | | boolean | [removeIf](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#removeIf(java.util.function.Predicate))([Predicate](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/Predicate.html)\ filter) Removes all of the elements of this collection that satisfy the given predicate. | | abstract boolean | [retainAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#retainAll(java.util.Collection))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Retains only the elements in this collection that are contained in the specified collection (optional operation). | | abstract int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#size())() Returns the number of elements in this collection. | | [Spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html)\ | [spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#spliterator())() Creates a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html` over the elements in this collection. | | [Stream](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/stream/Stream.html)\ | [stream](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#stream())() Returns a sequential `Stream` with this collection as its source. | | abstract \ T\[\] | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#toArray(T[]))(T\[\] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. | | abstract [Object\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [toArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#toArray())() Returns an array containing all of the elements in this collection. | From interface [java.util.Deque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html) |---|---| | abstract boolean | [add](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#add(E))(E e) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available. | | abstract void | [addFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#addFirst(E))(E e) Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. | | abstract void | [addLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#addLast(E))(E e) Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. | | abstract boolean | [contains](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#contains(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Returns `true` if this deque contains the specified element. | | abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [descendingIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#descendingIterator())() Returns an iterator over the elements in this deque in reverse sequential order. | | abstract E | [element](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#element())() Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). | | abstract E | [getFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#getFirst())() Retrieves, but does not remove, the first element of this deque. | | abstract E | [getLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#getLast())() Retrieves, but does not remove, the last element of this deque. | | abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#iterator())() Returns an iterator over the elements in this deque in proper sequence. | | abstract boolean | [offer](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#offer(E))(E e) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and `false` if no space is currently available. | | abstract boolean | [offerFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#offerFirst(E))(E e) Inserts the specified element at the front of this deque unless it would violate capacity restrictions. | | abstract boolean | [offerLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#offerLast(E))(E e) Inserts the specified element at the end of this deque unless it would violate capacity restrictions. | | abstract E | [peek](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#peek())() Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. | | abstract E | [peekFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#peekFirst())() Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty. | | abstract E | [peekLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#peekLast())() Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty. | | abstract E | [poll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#poll())() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. | | abstract E | [pollFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#pollFirst())() Retrieves and removes the first element of this deque, or returns `null` if this deque is empty. | | abstract E | [pollLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#pollLast())() Retrieves and removes the last element of this deque, or returns `null` if this deque is empty. | | abstract E | [pop](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#pop())() Pops an element from the stack represented by this deque. | | abstract void | [push](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#push(E))(E e) Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. | | abstract E | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#remove())() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). | | abstract boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the first occurrence of the specified element from this deque. | | abstract E | [removeFirst](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#removeFirst())() Retrieves and removes the first element of this deque. | | abstract boolean | [removeFirstOccurrence](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#removeFirstOccurrence(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the first occurrence of the specified element from this deque. | | abstract E | [removeLast](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#removeLast())() Retrieves and removes the last element of this deque. | | abstract boolean | [removeLastOccurrence](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#removeLastOccurrence(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the last occurrence of the specified element from this deque. | | abstract int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#size())() Returns the number of elements in this deque. | From interface [java.lang.Iterable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Iterable.html) |---|---| | void | [forEach](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Iterable.html#forEach(java.util.function.Consumer))([Consumer](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/Consumer.html)\ action) Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. | | abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ | [iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Iterable.html#iterator())() Returns an iterator over elements of type `T`. | | [Spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html)\ | [spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Iterable.html#spliterator())() Creates a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html` over the elements described by this `Iterable`. | From interface [java.util.Queue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html) |---|---| | abstract boolean | [add](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#add(E))(E e) Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available. | | abstract E | [element](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#element())() Retrieves, but does not remove, the head of this queue. | | abstract boolean | [offer](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#offer(E))(E e) Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. | | abstract E | [peek](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#peek())() Retrieves, but does not remove, the head of this queue, or returns `null` if this queue is empty. | | abstract E | [poll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#poll())() Retrieves and removes the head of this queue, or returns `null` if this queue is empty. | | abstract E | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#remove())() Retrieves and removes the head of this queue. | ## Public Constructors #### public **ArrayDeque** () Constructs an empty array deque with an initial capacity sufficient to hold 16 elements. #### public **ArrayDeque** (int numElements) Constructs an empty array deque with an initial capacity sufficient to hold the specified number of elements. ##### Parameters | numElements | lower bound on initial capacity of the deque | |---|---| #### public **ArrayDeque** ([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\ c) Constructs a deque containing the elements of the specified collection, in the order they are returned by the collection's iterator. (The first element returned by the collection's iterator becomes the first element, or *front* of the deque.) ##### Parameters | c | the collection whose elements are to be placed into the deque | |---|---| ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified collection is null | |---|---| ## Public Methods #### public boolean **add** (E e) Inserts the specified element at the end of this deque. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#addLast(E)`. ##### Parameters | e | the element to add | |---|---| ##### Returns - `true` (as specified by `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html#add(E)`) ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public void **addFirst** (E e) Inserts the specified element at the front of this deque. ##### Parameters | e | the element to add | |---|---| ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public void **addLast** (E e) Inserts the specified element at the end of this deque. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#add(E)`. ##### Parameters | e | the element to add | |---|---| ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public void **clear** () Removes all of the elements from this deque. The deque will be empty after this call returns. #### public [ArrayDeque](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html)\ **clone** () Returns a copy of this deque. ##### Returns - a copy of this deque #### public boolean **contains** ([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Returns `true` if this deque contains the specified element. More formally, returns `true` if and only if this deque contains at least one element `e` such that `o.equals(e)`. ##### Parameters | o | object to be checked for containment in this deque | |---|---| ##### Returns - `true` if this deque contains the specified element #### public [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ **descendingIterator** () Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head). ##### Returns - an iterator over the elements in this deque in reverse sequence #### public E **element** () Retrieves, but does not remove, the head of the queue represented by this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#peek()` only in that it throws an exception if this deque is empty. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#getFirst()`. ##### Returns - the head of the queue represented by this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public E **getFirst** () Retrieves, but does not remove, the first element of this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#peekFirst()` only in that it throws an exception if this deque is empty. ##### Returns - the head of this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public E **getLast** () Retrieves, but does not remove, the last element of this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#peekLast()` only in that it throws an exception if this deque is empty. ##### Returns - the tail of this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public boolean **isEmpty** () Returns `true` if this deque contains no elements. ##### Returns - `true` if this deque contains no elements #### public [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\ **iterator** () Returns an iterator over the elements in this deque. The elements will be ordered from first (head) to last (tail). This is the same order that elements would be dequeued (via successive calls to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#remove()` or popped (via successive calls to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#pop()`). ##### Returns - an iterator over the elements in this deque #### public boolean **offer** (E e) Inserts the specified element at the end of this deque. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#offerLast(E)`. ##### Parameters | e | the element to add | |---|---| ##### Returns - `true` (as specified by `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Queue.html#offer(E)`) ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public boolean **offerFirst** (E e) Inserts the specified element at the front of this deque. ##### Parameters | e | the element to add | |---|---| ##### Returns - `true` (as specified by `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#offerFirst(E)`) ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public boolean **offerLast** (E e) Inserts the specified element at the end of this deque. ##### Parameters | e | the element to add | |---|---| ##### Returns - `true` (as specified by `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#offerLast(E)`) ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public E **peek** () Retrieves, but does not remove, the head of the queue represented by this deque, or returns `null` if this deque is empty. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#peekFirst()`. ##### Returns - the head of the queue represented by this deque, or `null` if this deque is empty #### public E **peekFirst** () Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty. ##### Returns - the head of this deque, or `null` if this deque is empty #### public E **peekLast** () Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty. ##### Returns - the tail of this deque, or `null` if this deque is empty #### public E **poll** () Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#pollFirst()`. ##### Returns - the head of the queue represented by this deque, or `null` if this deque is empty #### public E **pollFirst** () Retrieves and removes the first element of this deque, or returns `null` if this deque is empty. ##### Returns - the head of this deque, or `null` if this deque is empty #### public E **pollLast** () Retrieves and removes the last element of this deque, or returns `null` if this deque is empty. ##### Returns - the tail of this deque, or `null` if this deque is empty #### public E **pop** () Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirst()`. ##### Returns - the element at the front of this deque (which is the top of the stack represented by this deque) ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public void **push** (E e) Pushes an element onto the stack represented by this deque. In other words, inserts the element at the front of this deque. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#addFirst(E)`. ##### Parameters | e | the element to push | |---|---| ##### Throws | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified element is null | |---|---| #### public E **remove** () Retrieves and removes the head of the queue represented by this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#poll()` only in that it throws an exception if this deque is empty. This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirst()`. ##### Returns - the head of the queue represented by this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public boolean **remove** ([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes a single instance of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element `e` such that `o.equals(e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). This method is equivalent to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#removeFirstOccurrence(java.lang.Object)`. ##### Parameters | o | element to be removed from this deque, if present | |---|---| ##### Returns - `true` if this deque contained the specified element #### public E **removeFirst** () Retrieves and removes the first element of this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#pollFirst()` only in that it throws an exception if this deque is empty. ##### Returns - the head of this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public boolean **removeFirstOccurrence** ([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the first occurrence of the specified element in this deque (when traversing the deque from head to tail). If the deque does not contain the element, it is unchanged. More formally, removes the first element `e` such that `o.equals(e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). ##### Parameters | o | element to be removed from this deque, if present | |---|---| ##### Returns - `true` if the deque contained the specified element #### public E **removeLast** () Retrieves and removes the last element of this deque. This method differs from `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Deque.html#pollLast()` only in that it throws an exception if this deque is empty. ##### Returns - the tail of this deque ##### Throws | [NoSuchElementException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/NoSuchElementException.html) | | |---|---| #### public boolean **removeLastOccurrence** ([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Removes the last occurrence of the specified element in this deque (when traversing the deque from head to tail). If the deque does not contain the element, it is unchanged. More formally, removes the last element `e` such that `o.equals(e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). ##### Parameters | o | element to be removed from this deque, if present | |---|---| ##### Returns - `true` if the deque contained the specified element #### public int **size** () Returns the number of elements in this deque. ##### Returns - the number of elements in this deque #### public [Spliterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html)\ **spliterator** () Creates a *[late-binding](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator#binding)* and *fail-fast* `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html` over the elements in this deque. The `Spliterator` reports `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html#SIZED`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html#SUBSIZED`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html#ORDERED`, and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Spliterator.html#NONNULL`. Overriding implementations should document the reporting of additional characteristic values. ##### Returns - a `Spliterator` over the elements in this deque #### public [Object\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) **toArray** () Returns an array containing all of the elements in this deque in proper sequence (from first to last element). The returned array will be "safe" in that no references to it are maintained by this deque. (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. ##### Returns - an array containing all of the elements in this deque #### public T\[\] **toArray** (T\[\] a) Returns an array containing all of the elements in this deque in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the deque 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 deque. If this deque fits in the specified array with room to spare (i.e., the array has more elements than this deque), the element in the array immediately following the end of the deque is set to `null`. Like the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ArrayDeque.html#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 deque known to contain only strings. The following code can be used to dump the deque 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()`.
##### Parameters | a | the array into which the elements of the deque are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose | |---|---| ##### Returns - an array containing all of the elements in this deque ##### Throws | [ArrayStoreException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArrayStoreException.html) | if the runtime type of the specified array is not a supertype of the runtime type of every element in this deque | | [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified array is null | |---|---|