|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractCollection<E> java16.util.ArrayDeque<E>
public class ArrayDeque<E>
Constructor Summary | |
---|---|
ArrayDeque()
Constructs an empty array deque with an initial capacity sufficient to hold 16 elements. |
|
ArrayDeque(java.util.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 | ||
---|---|---|
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(java.lang.Object o)
Returns true if this deque contains the specified element. |
|
java.util.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. |
|
java.util.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(java.lang.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(java.lang.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(java.lang.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. |
|
java.lang.Object[] |
toArray()
Returns an array containing all of the elements in this deque in proper sequence (from first to last element). |
|
|
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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Collection |
---|
addAll, containsAll, equals, hashCode, removeAll, retainAll |
Constructor Detail |
---|
public ArrayDeque()
public ArrayDeque(int numElements)
numElements
- lower bound on initial capacity of the dequepublic ArrayDeque(java.util.Collection<? extends E> c)
c
- the collection whose elements are to be placed into the deque
java.lang.NullPointerException
- if the specified collection is nullMethod Detail |
---|
public void addFirst(E e)
addFirst
in interface Deque<E>
e
- the element to add
java.lang.NullPointerException
- if the specified element is nullpublic void addLast(E e)
This method is equivalent to add(E)
.
addLast
in interface Deque<E>
e
- the element to add
java.lang.NullPointerException
- if the specified element is nullpublic boolean offerFirst(E e)
offerFirst
in interface Deque<E>
e
- the element to add
Deque.offerFirst(E)
)
java.lang.NullPointerException
- if the specified element is nullpublic boolean offerLast(E e)
offerLast
in interface Deque<E>
e
- the element to add
Deque.offerLast(E)
)
java.lang.NullPointerException
- if the specified element is nullpublic E removeFirst()
Deque
pollFirst
only in that it throws an
exception if this deque is empty.
removeFirst
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E removeLast()
Deque
pollLast
only in that it throws an
exception if this deque is empty.
removeLast
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E pollFirst()
Deque
pollFirst
in interface Deque<E>
public E pollLast()
Deque
pollLast
in interface Deque<E>
public E getFirst()
Deque
peekFirst
only in that it
throws an exception if this deque is empty.
getFirst
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E getLast()
Deque
peekLast
only in that it
throws an exception if this deque is empty.
getLast
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E peekFirst()
Deque
peekFirst
in interface Deque<E>
public E peekLast()
Deque
peekLast
in interface Deque<E>
public boolean removeFirstOccurrence(java.lang.Object o)
removeFirstOccurrence
in interface Deque<E>
o
- element to be removed from this deque, if present
public boolean removeLastOccurrence(java.lang.Object o)
removeLastOccurrence
in interface Deque<E>
o
- element to be removed from this deque, if present
public boolean add(E e)
This method is equivalent to addLast(E)
.
add
in interface java.util.Collection<E>
add
in interface java.util.Queue<E>
add
in interface Deque<E>
add
in class java.util.AbstractCollection<E>
e
- the element to add
Collection.add(E)
)
java.lang.NullPointerException
- if the specified element is nullpublic boolean offer(E e)
This method is equivalent to offerLast(E)
.
offer
in interface java.util.Queue<E>
offer
in interface Deque<E>
e
- the element to add
Queue.offer(E)
)
java.lang.NullPointerException
- if the specified element is nullpublic E remove()
poll
only in that it throws an
exception if this deque is empty.
This method is equivalent to removeFirst()
.
remove
in interface java.util.Queue<E>
remove
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E poll()
This method is equivalent to pollFirst()
.
poll
in interface java.util.Queue<E>
poll
in interface Deque<E>
public E element()
peek
only in
that it throws an exception if this deque is empty.
This method is equivalent to getFirst()
.
element
in interface java.util.Queue<E>
element
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic E peek()
This method is equivalent to peekFirst()
.
peek
in interface java.util.Queue<E>
peek
in interface Deque<E>
public void push(E e)
This method is equivalent to addFirst(E)
.
push
in interface Deque<E>
e
- the element to push
java.lang.NullPointerException
- if the specified element is nullpublic E pop()
This method is equivalent to removeFirst()
.
pop
in interface Deque<E>
java.util.NoSuchElementException
- if this deque is emptypublic int size()
size
in interface java.util.Collection<E>
size
in interface Deque<E>
size
in class java.util.AbstractCollection<E>
public boolean isEmpty()
isEmpty
in interface java.util.Collection<E>
isEmpty
in class java.util.AbstractCollection<E>
public java.util.Iterator<E> iterator()
remove()
or popped (via successive calls to pop()
).
iterator
in interface java.lang.Iterable<E>
iterator
in interface java.util.Collection<E>
iterator
in interface Deque<E>
iterator
in class java.util.AbstractCollection<E>
public java.util.Iterator<E> descendingIterator()
Deque
descendingIterator
in interface Deque<E>
public boolean contains(java.lang.Object o)
contains
in interface java.util.Collection<E>
contains
in interface Deque<E>
contains
in class java.util.AbstractCollection<E>
o
- object to be checked for containment in this deque
public boolean remove(java.lang.Object o)
This method is equivalent to removeFirstOccurrence(java.lang.Object)
.
remove
in interface java.util.Collection<E>
remove
in interface Deque<E>
remove
in class java.util.AbstractCollection<E>
o
- element to be removed from this deque, if present
public void clear()
clear
in interface java.util.Collection<E>
clear
in class java.util.AbstractCollection<E>
public java.lang.Object[] toArray()
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.
toArray
in interface java.util.Collection<E>
toArray
in class java.util.AbstractCollection<E>
public <T> T[] toArray(T[] a)
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().
toArray
in interface java.util.Collection<E>
toArray
in class java.util.AbstractCollection<E>
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
java.lang.ArrayStoreException
- if the runtime type of the specified array
is not a supertype of the runtime type of every element in
this deque
java.lang.NullPointerException
- if the specified array is nullpublic ArrayDeque<E> clone()
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |