- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.ArrayDeque<E>
-
- Type Parameters:
E
- the type of elements held in this collection
- All Implemented Interfaces:
- Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, Queue<E>
public class ArrayDeque<E> extends AbstractCollection<E> implements Deque<E>, Cloneable, Serializable
Resizable-array implementation of theDeque
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 thanStack
when used as a stack, and faster thanLinkedList
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
andIterator
interfaces.This class is a member of the Java Collections Framework.
- Since:
- 1.6
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description ArrayDeque()
Constructs an empty array deque with an initial capacity sufficient to hold 16 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.ArrayDeque(int numElements)
Constructs an empty array deque with an initial capacity sufficient to hold the specified number of elements.
-
Method Summary
Methods Modifier and Type Method and Description boolean
add(E e)
Inserts the specified element at the end of this deque.void
addFirst(E e)
Inserts the specified element at the front of this deque.void
addLast(E e)
Inserts the specified element at the end of this deque.void
clear()
Removes all of the elements from this deque.ArrayDeque<E>
clone()
Returns a copy of this deque.boolean
contains(Object o)
Returns true if this deque contains the specified element.Iterator<E>
descendingIterator()
Returns an iterator over the elements in this deque in reverse sequential order.E
element()
Retrieves, but does not remove, the head of the queue represented by this deque.E
getFirst()
Retrieves, but does not remove, the first element of this deque.E
getLast()
Retrieves, but does not remove, the last element of this deque.boolean
isEmpty()
Returns true if this deque contains no elements.Iterator<E>
iterator()
Returns an iterator over the elements in this deque.boolean
offer(E e)
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
offerLast(E e)
Inserts the specified element at the end of this deque.E
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()
Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.E
peekLast()
Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.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.E
pollFirst()
Retrieves and removes the first element of this deque, or returns null if this deque is empty.E
pollLast()
Retrieves and removes the last element of this deque, or returns null if this deque is empty.E
pop()
Pops an element from the stack represented by this deque.void
push(E e)
Pushes an element onto the stack represented by this deque.E
remove()
Retrieves and removes the head of the queue represented by this deque.boolean
remove(Object o)
Removes a single instance of the specified element from this deque.E
removeFirst()
Retrieves and removes the first element of this deque.boolean
removeFirstOccurrence(Object o)
Removes the first occurrence of the specified element in this deque (when traversing the deque from head to tail).E
removeLast()
Retrieves and removes the last element of this deque.boolean
removeLastOccurrence(Object o)
Removes the last occurrence of the specified element in this deque (when traversing the deque from head to tail).int
size()
Returns the number of 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
addAll, containsAll, removeAll, retainAll, toString
-
-
-
-
Constructor Detail
-
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
public 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. (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 Detail
-
addFirst
public void addFirst(E e)
Inserts the specified element at the front of this deque.- Specified by:
addFirst
in interfaceDeque<E>
- Parameters:
e
- the element to add- Throws:
NullPointerException
- if the specified element is null
-
addLast
public void addLast(E e)
Inserts the specified element at the end of this deque.This method is equivalent to
add(E)
.- Specified by:
addLast
in interfaceDeque<E>
- Parameters:
e
- the element to add- Throws:
NullPointerException
- if the specified element is null
-
offerFirst
public boolean offerFirst(E e)
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 by
Deque.offerFirst(E)
) - Throws:
NullPointerException
- if the specified element is null
-
offerLast
public boolean offerLast(E e)
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 by
Deque.offerLast(E)
) - Throws:
NullPointerException
- if the specified element is null
-
removeFirst
public E 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>
- Returns:
- the head of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
removeLast
public E 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>
- Returns:
- the tail of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
pollFirst
public E pollFirst()
Description copied from interface:Deque
Retrieves and removes the first element of this deque, or returns null if this deque is empty.
-
pollLast
public E pollLast()
Description copied from interface:Deque
Retrieves and removes the last element of this deque, or returns null if this deque is empty.
-
getFirst
public E 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>
- Returns:
- the head of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
getLast
public E 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>
- Returns:
- the tail of this deque
- Throws:
NoSuchElementException
- if this deque is empty
-
peekFirst
public E peekFirst()
Description copied from interface:Deque
Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.
-
peekLast
public E peekLast()
Description copied from interface:Deque
Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.
-
removeFirstOccurrence
public boolean removeFirstOccurrence(Object 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).- 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
public boolean removeLastOccurrence(Object 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).- 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
public boolean add(E e)
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 by
Collection.add(E)
) - Throws:
NullPointerException
- if the specified element is null
-
offer
public boolean offer(E e)
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 by
Queue.offer(E)
) - Throws:
NullPointerException
- if the specified element is null
-
remove
public E 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
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
pollFirst()
.
-
element
public E 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
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
peekFirst()
.
-
push
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
addFirst(E)
.- Specified by:
push
in interfaceDeque<E>
- Parameters:
e
- the element to push- Throws:
NullPointerException
- if the specified element is null
-
pop
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
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()
Returns true 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
-
descendingIterator
public Iterator<E> 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
-
contains
public boolean contains(Object 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).- 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
public boolean remove(Object 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
removeFirstOccurrence(java.lang.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
public Object[] 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 of String:
String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to toArray().- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classAbstractCollection<E>
- 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
public ArrayDeque<E> clone()
Returns a copy of this deque.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/util/arraydeque.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.