public interface java.util
Deque<E>


Hide details Login
Java SE 6
  
Implements: Queue
Implemented by: ArrayDeque, BlockingDeque, LinkedList

A linear collection that supports element insertion and removal at both ends. The name deque is short for "double ended queue" and is usually pronounced "deck". Most Deque implementations place no fixed limits on the number of elements they may contain, but this interface supports capacity-restricted deques as well as those with no fixed size limit.

This interface defines methods to access the elements at both ends of the deque. Methods are provided to insert, remove, and examine the element. Each of these methods exists in two forms: one throws an exception if the operation fails, the other returns a special value (either null or false, depending on the operation). The latter form of the insert operation is designed specifically for use with capacity-restricted Deque implementations; in most implementations, insert operations cannot fail.

The twelve methods described above are summarized in the following table:

First Element (Head) Last Element (Tail)
Throws exception Special value Throws exception Special value
Insert addFirst(e) offerFirst(e) addLast(e) offerLast(e)
Remove removeFirst() pollFirst() removeLast() pollLast()
Examine getFirst() peekFirst() getLast() peekLast()

This interface extends the Queue interface. When a deque is used as a queue, FIFO (First-In-First-Out) behavior results. Elements are added at the end of the deque and removed from the beginning. The methods inherited from the Queue interface are precisely equivalent to Deque methods as indicated in the following table:

Queue Method Equivalent Deque Method
add(e) addLast(e)
offer(e) offerLast(e)
remove() removeFirst()
poll() pollFirst()
element() getFirst()
peek() peekFirst()

Deques can also be used as LIFO (Last-In-First-Out) stacks. This interface should be used in preference to the legacy Stack class. When a deque is used as a stack, elements are pushed and popped from the beginning of the deque. Stack methods are precisely equivalent to Deque methods as indicated in the table below:

Stack Method Equivalent Deque Method
push(e) addFirst(e)
pop() removeFirst()
peek() peekFirst()

Note that the peek method works equally well when a deque is used as a queue or a stack; in either case, elements are drawn from the beginning of the deque.

This interface provides two methods to remove interior elements, removeFirstOccurrence and removeLastOccurrence.

Unlike the List interface, this interface does not provide support for indexed access to elements.

While Deque implementations are not strictly required to prohibit the insertion of null elements, they are strongly encouraged to do so. Users of any Deque implementations that do allow null elements are strongly encouraged not to take advantage of the ability to insert nulls. This is so because null is used as a special return value by various methods to indicated that the deque is empty.

Deque implementations generally do not define element-based versions of the equals and hashCode methods, but instead inherit the identity-based versions from class Object.

This interface is a member of the Java Collections Framework.
since1.6
Ethe type of elements held in this collection


Methods
public boolean add(Object 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. When using a capacity-restricted deque, it is generally preferable to use offer.

This method is equivalent to #addLast.
ethe element to add
returntrue (as specified by Collection#add)
ThrowsIllegalStateException: if the element cannot be added at this time due to capacity restrictions
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque

public void addFirst(Object e)
Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method #offerFirst.
ethe element to add
ThrowsIllegalStateException: if the element cannot be added at this time due to capacity restrictions
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque
public void addLast(Object e)
Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method #offerLast.

This method is equivalent to #add.
ethe element to add
ThrowsIllegalStateException: if the element cannot be added at this time due to capacity restrictions
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque

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==null ? e==null : o.equals(e)).
oelement whose presence in this deque is to be tested
returntrue if this deque contains the specified element
ThrowsClassCastException: if the type of the specified element is incompatible with this deque (optional)
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements (optional)
public Iterator 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).
returnan iterator over the elements in this deque in reverse sequence
public Object element()
Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

This method is equivalent to #getFirst().
returnthe head of the queue represented by this deque
ThrowsNoSuchElementException: if this deque is empty

public Iterator iterator()
Returns an iterator over the elements in this deque in proper sequence. The elements will be returned in order from first (head) to last (tail).
returnan iterator over the elements in this deque in proper sequence
public boolean offer(Object 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. When using a capacity-restricted deque, this method is generally preferable to the #add method, which can fail to insert an element only by throwing an exception.

This method is equivalent to #offerLast.
ethe element to add
returntrue if the element was added to this deque, else false
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque

public boolean offerFirst(Object e)
Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the #addFirst method, which can fail to insert an element only by throwing an exception.
ethe element to add
returntrue if the element was added to this deque, else false
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque
public boolean offerLast(Object e)
Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the #addLast method, which can fail to insert an element only by throwing an exception.
ethe element to add
returntrue if the element was added to this deque, else false
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque
public Object 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.

This method is equivalent to #peekFirst().
returnthe head of the queue represented by this deque, or null if this deque is empty

public Object peekFirst()
Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.
returnthe head of this deque, or null if this deque is empty
public Object peekLast()
Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.
returnthe tail of this deque, or null if this deque is empty
public Object 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().
returnthe first element of this deque, or null if this deque is empty

public Object pollFirst()
Retrieves and removes the first element of this deque, or returns null if this deque is empty.
returnthe head of this deque, or null if this deque is empty
public Object pollLast()
Retrieves and removes the last element of this deque, or returns null if this deque is empty.
returnthe tail of this deque, or null if this deque is empty
public Object 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().
returnthe element at the front of this deque (which is the top of the stack represented by this deque)
ThrowsNoSuchElementException: if this deque is empty

public void push(Object 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, returning true upon success and throwing an IllegalStateException if no space is currently available.

This method is equivalent to #addFirst.
ethe element to push
ThrowsIllegalStateException: if the element cannot be added at this time due to capacity restrictions
ThrowsClassCastException: if the class of the specified element prevents it from being added to this deque
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements
ThrowsIllegalArgumentException: if some property of the specified element prevents it from being added to this deque

public Object remove()
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll only in that it throws an exception if this deque is empty.

This method is equivalent to #removeFirst().
returnthe head of the queue represented by this deque
ThrowsNoSuchElementException: if this deque is empty

public boolean remove(Object o)
Removes the first occurrence 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==null ? e==null : 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.
oelement to be removed from this deque, if present
returntrue if an element was removed as a result of this call
ThrowsClassCastException: if the class of the specified element is incompatible with this deque (optional)
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements (optional)

public Object removeFirst()
Retrieves and removes the first element of this deque. This method differs from pollFirst only in that it throws an exception if this deque is empty.
returnthe head of this deque
ThrowsNoSuchElementException: if this deque is empty
public boolean removeFirstOccurrence(Object o)
Removes the first occurrence 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==null ? e==null : 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).
oelement to be removed from this deque, if present
returntrue if an element was removed as a result of this call
ThrowsClassCastException: if the class of the specified element is incompatible with this deque (optional)
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements (optional)
public Object removeLast()
Retrieves and removes the last element of this deque. This method differs from pollLast only in that it throws an exception if this deque is empty.
returnthe tail of this deque
ThrowsNoSuchElementException: if this deque is empty
public boolean removeLastOccurrence(Object o)
Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that (o==null ? e==null : 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).
oelement to be removed from this deque, if present
returntrue if an element was removed as a result of this call
ThrowsClassCastException: if the class of the specified element is incompatible with this deque (optional)
ThrowsNullPointerException: if the specified element is null and this deque does not permit null elements (optional)
public int size()
Returns the number of elements in this deque.
returnthe number of elements in this deque

Properties
public Object getFirst()
Retrieves, but does not remove, the first element of this deque. This method differs from peekFirst only in that it throws an exception if this deque is empty.
returnthe head of this deque
ThrowsNoSuchElementException: if this deque is empty
public Object getLast()
Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.
returnthe tail of this deque
ThrowsNoSuchElementException: if this deque is empty
About DocWeb · Bundles · Export · Export AllTop 10 · Statistics · Login
About Sun · Contact · Privacy · Terms of Use · Trademarks
Java SE 6
· Copyright © 1994-2009 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms