Class ArrayDeque<E>
- Type Parameters:
E
- the type of elements held in this deque
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,Deque<E>
,Queue<E>
,SequencedCollection<E>
Deque
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
Stack
when used as a stack, and faster than LinkedList
when used as a queue.
Most ArrayDeque
operations run in amortized constant time.
Exceptions include
remove
,
removeFirstOccurrence
,
removeLastOccurrence
,
contains
,
iterator.remove()
,
and the bulk operations, all of which run in linear time.
The iterators returned by this class's 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 ConcurrentModificationException
. 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
Collection
, SequencedCollection
, and Iterator
interfaces.
This class is a member of the Java Collections Framework.
- Since:
- 1.6
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs an empty array deque with an initial capacity sufficient to hold 16 elements.ArrayDeque
(int numElements) Constructs an empty array deque with an initial capacity sufficient to hold the specified number of elements.ArrayDeque
(Collection<? extends E> c) Constructs a deque containing the elements of the specified collection, in the order they are returned by the collection's iterator. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Inserts the specified element at the end of this deque.boolean
addAll
(Collection<? extends E> c) Adds all of the elements in the specified collection at the end of this deque, as if by callingaddLast(E)
on each one, in the order that they are returned by the collection's iterator.void
Inserts the specified element at the front of this deque.void
Inserts the specified element at the end of this deque.void
clear()
Removes all of the elements from this deque.clone()
Returns a copy of this deque.boolean
Returnstrue
if this deque contains the specified element.Returns an iterator over the elements in this deque in reverse sequential order.element()
Retrieves, but does not remove, the head of the queue represented by this deque.void
Performs the given action for each element of theIterable
until all elements have been processed or the action throws an exception.getFirst()
Retrieves, but does not remove, the first element of this deque.getLast()
Retrieves, but does not remove, the last element of this deque.boolean
isEmpty()
Returnstrue
if this deque contains no elements.iterator()
Returns an iterator over the elements in this deque.boolean
Inserts the specified element at the end of this deque.boolean
offerFirst
(E e) Inserts the specified element at the front of this deque.boolean
Inserts the specified element at the end of this deque.peek()
Retrieves, but does not remove, the head of the queue represented by this deque, or returnsnull
if this deque is empty.Retrieves, but does not remove, the first element of this deque, or returnsnull
if this deque is empty.peekLast()
Retrieves, but does not remove, the last element of this deque, or returnsnull
if this deque is empty.poll()
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returnsnull
if this deque is empty.Retrieves and removes the first element of this deque, or returnsnull
if this deque is empty.pollLast()
Retrieves and removes the last element of this deque, or returnsnull
if this deque is empty.pop()
Pops an element from the stack represented by this deque.void
Pushes an element onto the stack represented by this deque.remove()
Retrieves and removes the head of the queue represented by this deque.boolean
Removes a single instance of the specified element from this deque.boolean
removeAll
(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).Retrieves and removes the first element of this deque.boolean
Removes the first occurrence of the specified element in this deque (when traversing the deque from head to tail).boolean
Removes all of the elements of this collection that satisfy the given predicate (optional operation).Retrieves and removes the last element of this deque.boolean
Removes the last occurrence of the specified element in this deque (when traversing the deque from head to tail).boolean
retainAll
(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).int
size()
Returns the number of elements in this deque.Creates a late-binding and fail-fastSpliterator
over the elements in this deque.Object[]
toArray()
Returns an array containing all of the elements in this deque in proper sequence (from first to last element).<T> 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.Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
containsAll, equals, hashCode, parallelStream, stream, toArray
-
Constructor Details
-
ArrayDeque
public ArrayDeque()Constructs an empty array deque with an initial capacity sufficient to hold 16 elements. -
ArrayDeque
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
-
ArrayDeque
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
- if the specified collection is null
-
-
Method Details
-
addFirst
Inserts the specified element at the front of this deque.- Specified by:
addFirst
in interfaceDeque<E>
- Specified by:
addFirst
in interfaceSequencedCollection<E>
- Parameters:
e
- the element to add- Throws:
NullPointerException
- if the specified element is null
-
addLast
Inserts the specified element at the end of this deque.This method is equivalent to
add(E)
.- Specified by:
addLast
in interfaceDeque<E>
- Specified by:
addLast
in interfaceSequencedCollection<E>
- Parameters:
e
- the element to add- Throws:
NullPointerException
- if the specified element is null
-
addAll
Adds all of the elements in the specified collection at the end of this deque, as if by callingaddLast(E)
on each one, in the order that they are returned by the collection's iterator.- Specified by:
addAll
in interfaceCollection<E>
- Specified by:
addAll
in interfaceDeque<E>
- Overrides:
addAll
in classAbstractCollection<E>
- Parameters:
c
- the elements to be inserted into this deque- Returns:
true
if this deque changed as a result of the call- Throws:
NullPointerException
- if the specified collection or any of its elements are null- See Also:
-
offerFirst
Inserts the specified element at the front of this deque.- Specified by:
offerFirst
in interfaceDeque<E>
- Parameters:
e
- the element to add- Returns:
true
(as specified byDeque.offerFirst(E)
)- Throws:
NullPointerException
- if the specified element is null
-
offerLast
Inserts the specified element at the end of this deque.- Specified by:
offerLast
in interfaceDeque<E>
- Parameters:
e
- the element to add- Returns:
true
(as specified byDeque.offerLast(E)
)- Throws:
NullPointerException
- if the specified element is null
-
removeFirst
Description copied from interface:Deque
Retrieves and removes the first element of this deque. This method differs frompollFirst
only in that it throws an exception if this deque is empty.- Specified by:
removeFirst
in interfaceDeque<E>
- Specified by:
removeFirst
in interfaceSequencedCollection<E>
- Returns:
- the head of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
removeLast
Description copied from interface:Deque
Retrieves and removes the last element of this deque. This method differs frompollLast
only in that it throws an exception if this deque is empty.- Specified by:
removeLast
in interfaceDeque<E>
- Specified by:
removeLast
in interfaceSequencedCollection<E>
- Returns:
- the tail of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
pollFirst
-
pollLast
-
getFirst
Description copied from interface:Deque
Retrieves, but does not remove, the first element of this deque. This method differs frompeekFirst
only in that it throws an exception if this deque is empty.- Specified by:
getFirst
in interfaceDeque<E>
- Specified by:
getFirst
in interfaceSequencedCollection<E>
- Returns:
- the head of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
getLast
Description copied from interface:Deque
Retrieves, but does not remove, the last element of this deque. This method differs frompeekLast
only in that it throws an exception if this deque is empty.- Specified by:
getLast
in interfaceDeque<E>
- Specified by:
getLast
in interfaceSequencedCollection<E>
- Returns:
- the tail of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
peekFirst
-
peekLast
-
removeFirstOccurrence
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 elemente
such thato.equals(e)
(if such an element exists). Returnstrue
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).- Specified by:
removeFirstOccurrence
in interfaceDeque<E>
- Parameters:
o
- element to be removed from this deque, if present- Returns:
true
if the deque contained the specified element
-
removeLastOccurrence
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 elemente
such thato.equals(e)
(if such an element exists). Returnstrue
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).- Specified by:
removeLastOccurrence
in interfaceDeque<E>
- Parameters:
o
- element to be removed from this deque, if present- Returns:
true
if the deque contained the specified element
-
add
Inserts the specified element at the end of this deque.This method is equivalent to
addLast(E)
.- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceDeque<E>
- Specified by:
add
in interfaceQueue<E>
- Overrides:
add
in classAbstractCollection<E>
- Parameters:
e
- the element to add- Returns:
true
(as specified byCollection.add(E)
)- Throws:
NullPointerException
- if the specified element is null
-
offer
Inserts the specified element at the end of this deque.This method is equivalent to
offerLast(E)
.- Specified by:
offer
in interfaceDeque<E>
- Specified by:
offer
in interfaceQueue<E>
- Parameters:
e
- the element to add- Returns:
true
(as specified byQueue.offer(E)
)- Throws:
NullPointerException
- if the specified element is null
-
remove
Retrieves and removes the head of the queue represented by this deque. This method differs frompoll()
only in that it throws an exception if this deque is empty.This method is equivalent to
removeFirst()
. -
poll
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returnsnull
if this deque is empty.This method is equivalent to
pollFirst()
. -
element
Retrieves, but does not remove, the head of the queue represented by this deque. This method differs frompeek
only in that it throws an exception if this deque is empty.This method is equivalent to
getFirst()
. -
peek
Retrieves, but does not remove, the head of the queue represented by this deque, or returnsnull
if this deque is empty.This method is equivalent to
peekFirst()
. -
push
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
addFirst(E)
.- Specified by:
push
in interfaceDeque<E>
- Parameters:
e
- the element to push- Throws:
NullPointerException
- if the specified element is null
-
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
removeFirst()
.- Specified by:
pop
in interfaceDeque<E>
- Returns:
- the element at the front of this deque (which is the top of the stack represented by this deque)
- Throws:
NoSuchElementException
- if this deque is empty
-
size
public int size()Returns the number of elements in this deque.- Specified by:
size
in interfaceCollection<E>
- Specified by:
size
in interfaceDeque<E>
- Specified by:
size
in classAbstractCollection<E>
- Returns:
- the number of elements in this deque
-
isEmpty
public boolean isEmpty()Returnstrue
if this deque contains no elements.- Specified by:
isEmpty
in interfaceCollection<E>
- Overrides:
isEmpty
in classAbstractCollection<E>
- Returns:
true
if this deque contains no elements
-
iterator
-
descendingIterator
Description copied from interface:Deque
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).- Specified by:
descendingIterator
in interfaceDeque<E>
- Returns:
- an iterator over the elements in this deque in reverse sequence
-
spliterator
Creates a late-binding and fail-fastSpliterator
over the elements in this deque.The
Spliterator
reportsSpliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
, andSpliterator.NONNULL
. Overriding implementations should document the reporting of additional characteristic values.- Specified by:
spliterator
in interfaceCollection<E>
- Specified by:
spliterator
in interfaceIterable<E>
- Returns:
- a
Spliterator
over the elements in this deque - Since:
- 1.8
-
forEach
Description copied from interface:Iterable
Performs the given action for each element of theIterable
until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.
- Specified by:
forEach
in interfaceIterable<E>
- Parameters:
action
- The action to be performed for each element- Throws:
NullPointerException
- if the specified action is null
-
removeIf
Description copied from interface:Collection
Removes all of the elements of this collection that satisfy the given predicate (optional operation). Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.- Specified by:
removeIf
in interfaceCollection<E>
- Parameters:
filter
- a predicate which returnstrue
for elements to be removed- Returns:
true
if any elements were removed- Throws:
NullPointerException
- if the specified filter is null
-
removeAll
Description copied from class:AbstractCollection
Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.- Specified by:
removeAll
in interfaceCollection<E>
- Overrides:
removeAll
in classAbstractCollection<E>
- Parameters:
c
- collection containing elements to be removed from this collection- Returns:
true
if this collection changed as a result of the call- Throws:
NullPointerException
- if this collection contains one or more null elements and the specified collection does not support null elements (optional) or if the specified collection is null- See Also:
-
retainAll
Description copied from class:AbstractCollection
Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.- Specified by:
retainAll
in interfaceCollection<E>
- Overrides:
retainAll
in classAbstractCollection<E>
- Parameters:
c
- collection containing elements to be retained in this collection- Returns:
true
if this collection changed as a result of the call- Throws:
NullPointerException
- if this collection contains one or more null elements and the specified collection does not permit null elements (optional) or if the specified collection is null- See Also:
-
contains
Returnstrue
if this deque contains the specified element. More formally, returnstrue
if and only if this deque contains at least one elemente
such thato.equals(e)
.- Specified by:
contains
in interfaceCollection<E>
- Specified by:
contains
in interfaceDeque<E>
- Overrides:
contains
in classAbstractCollection<E>
- Parameters:
o
- object to be checked for containment in this deque- Returns:
true
if this deque contains the specified element
-
remove
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 elemente
such thato.equals(e)
(if such an element exists). Returnstrue
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).This method is equivalent to
removeFirstOccurrence(Object)
.- Specified by:
remove
in interfaceCollection<E>
- Specified by:
remove
in interfaceDeque<E>
- Overrides:
remove
in classAbstractCollection<E>
- Parameters:
o
- element to be removed from this deque, if present- Returns:
true
if this deque contained the specified element
-
clear
public void clear()Removes all of the elements from this deque. The deque will be empty after this call returns.- Specified by:
clear
in interfaceCollection<E>
- Overrides:
clear
in classAbstractCollection<E>
-
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.
- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Returns:
- an array containing all of the elements in this deque
-
toArray
public <T> 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
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 ofString
:String[] y = x.toArray(new String[0]);
toArray(new Object[0])
is identical in function totoArray()
.- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Type Parameters:
T
- the component type of the array to contain the collection- 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
- if the runtime type of the specified array is not a supertype of the runtime type of every element in this dequeNullPointerException
- if the specified array is null
-
clone
Returns a copy of this deque.
-