File	Doc	Category	Size	Date	Package
BlockingDeque.java	API Doc	Java SE 6 API	25341	Tue Jun 10 00:25:56 BST 2008	java.util.concurrent

BlockingDeque

Fields Summary

Constructors Summary

Methods Summary
public boolean	add(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. When using a capacity-restricted deque, it is generally preferable to use {@link #offer(Object) offer}. This method is equivalent to {@link #addLast(Object) addLast}. param e the element to add throws IllegalStateException {@inheritDoc} throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public void	addFirst(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. When using a capacity-restricted deque, it is generally preferable to use {@link #offerFirst(Object) offerFirst}. param e the element to add throws IllegalStateException {@inheritDoc} throws ClassCastException {@inheritDoc} throws NullPointerException if the specified element is null throws IllegalArgumentException {@inheritDoc}
public void	addLast(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. When using a capacity-restricted deque, it is generally preferable to use {@link #offerLast(Object) offerLast}. param e the element to add throws IllegalStateException {@inheritDoc} throws ClassCastException {@inheritDoc} throws NullPointerException if the specified element is null throws IllegalArgumentException {@inheritDoc}
public boolean	contains(java.lang.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). param o object to be checked for containment in this deque return true if this deque contains the specified element throws ClassCastException if the class of the specified element is incompatible with this deque (optional) throws NullPointerException if the specified element is null (optional)
public E	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 {@link #peek peek} only in that it throws an exception if this deque is empty. This method is equivalent to {@link #getFirst() getFirst}. return the head of this deque throws NoSuchElementException if this deque is empty
public java.util.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). return an iterator over the elements in this deque in proper sequence
public boolean	offer(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. When using a capacity-restricted deque, this method is generally preferable to the {@link #add} method, which can fail to insert an element only by throwing an exception. This method is equivalent to {@link #offerLast(Object) offerLast}. param e the element to add throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public boolean	offer(E e, long timeout, java.util.concurrent.TimeUnit unit) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque), waiting up to the specified wait time if necessary for space to become available. This method is equivalent to {@link #offerLast(Object,long,TimeUnit) offerLast}. param e the element to add return true if the element was added to this deque, else false throws InterruptedException {@inheritDoc} throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public boolean	offerFirst(E e) Inserts the specified element at the front 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 {@link #addFirst(Object) addFirst} method, which can fail to insert an element only by throwing an exception. param e the element to add throws ClassCastException {@inheritDoc} throws NullPointerException if the specified element is null throws IllegalArgumentException {@inheritDoc}
public boolean	offerFirst(E e, long timeout, java.util.concurrent.TimeUnit unit) Inserts the specified element at the front of this deque, waiting up to the specified wait time if necessary for space to become available. param e the element to add param timeout how long to wait before giving up, in units of unit param unit a TimeUnit determining how to interpret the timeout parameter return true if successful, or false if the specified waiting time elapses before space is available throws InterruptedException if interrupted while waiting throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public boolean	offerLast(E e) Inserts the specified element at the end 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 {@link #addLast(Object) addLast} method, which can fail to insert an element only by throwing an exception. param e the element to add throws ClassCastException {@inheritDoc} throws NullPointerException if the specified element is null throws IllegalArgumentException {@inheritDoc}
public boolean	offerLast(E e, long timeout, java.util.concurrent.TimeUnit unit) Inserts the specified element at the end of this deque, waiting up to the specified wait time if necessary for space to become available. param e the element to add param timeout how long to wait before giving up, in units of unit param unit a TimeUnit determining how to interpret the timeout parameter return true if successful, or false if the specified waiting time elapses before space is available throws InterruptedException if interrupted while waiting throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public E	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 {@link #peekFirst() peekFirst}. return the head 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 {@link #pollFirst()}. return the head of this deque, or null if this deque is empty
public E	poll(long timeout, java.util.concurrent.TimeUnit unit) Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), waiting up to the specified wait time if necessary for an element to become available. This method is equivalent to {@link #pollFirst(long,TimeUnit) pollFirst}. return the head of this deque, or null if the specified waiting time elapses before an element is available throws InterruptedException if interrupted while waiting
public E	pollFirst(long timeout, java.util.concurrent.TimeUnit unit) Retrieves and removes the first element of this deque, waiting up to the specified wait time if necessary for an element to become available. param timeout how long to wait before giving up, in units of unit param unit a TimeUnit determining how to interpret the timeout parameter return the head of this deque, or null if the specified waiting time elapses before an element is available throws InterruptedException if interrupted while waiting
public E	pollLast(long timeout, java.util.concurrent.TimeUnit unit) Retrieves and removes the last element of this deque, waiting up to the specified wait time if necessary for an element to become available. param timeout how long to wait before giving up, in units of unit param unit a TimeUnit determining how to interpret the timeout parameter return the tail of this deque, or null if the specified waiting time elapses before an element is available throws InterruptedException if interrupted while waiting
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 unless it would violate capacity restrictions. This method is equivalent to {@link #addFirst(Object) addFirst}. throws IllegalStateException {@inheritDoc} throws ClassCastException {@inheritDoc} throws NullPointerException if the specified element is null throws IllegalArgumentException {@inheritDoc}
public void	put(E e) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque), waiting if necessary for space to become available. This method is equivalent to {@link #putLast(Object) putLast}. param e the element to add throws InterruptedException {@inheritDoc} throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public void	putFirst(E e) Inserts the specified element at the front of this deque, waiting if necessary for space to become available. param e the element to add throws InterruptedException if interrupted while waiting throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public void	putLast(E e) Inserts the specified element at the end of this deque, waiting if necessary for space to become available. param e the element to add throws InterruptedException if interrupted while waiting throws ClassCastException if the class of the specified element prevents it from being added to this deque throws NullPointerException if the specified element is null throws IllegalArgumentException if some property of the specified element prevents it from being added to this deque
public E	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 {@link #poll poll} only in that it throws an exception if this deque is empty. This method is equivalent to {@link #removeFirst() removeFirst}. return the head of the queue represented by this deque throws NoSuchElementException if this deque is empty
public boolean	remove(java.lang.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.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 {@link #removeFirstOccurrence(Object) removeFirstOccurrence}. param o element to be removed from this deque, if present return true if this deque changed as a result of the call throws ClassCastException if the class of the specified element is incompatible with this deque (optional) throws NullPointerException if the specified element is null (optional)
public boolean	removeFirstOccurrence(java.lang.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.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). param o element to be removed from this deque, if present return true if an element was removed as a result of this call throws ClassCastException if the class of the specified element is incompatible with this deque (optional) throws NullPointerException if the specified element is null (optional)
public boolean	removeLastOccurrence(java.lang.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.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). param o element to be removed from this deque, if present return true if an element was removed as a result of this call throws ClassCastException if the class of the specified element is incompatible with this deque (optional) throws NullPointerException if the specified element is null (optional)
public int	size() Returns the number of elements in this deque. return the number of elements in this deque
public E	take() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), waiting if necessary until an element becomes available. This method is equivalent to {@link #takeFirst() takeFirst}. return the head of this deque throws InterruptedException if interrupted while waiting
public E	takeFirst() Retrieves and removes the first element of this deque, waiting if necessary until an element becomes available. return the head of this deque throws InterruptedException if interrupted while waiting
public E	takeLast() Retrieves and removes the last element of this deque, waiting if necessary until an element becomes available. return the tail of this deque throws InterruptedException if interrupted while waiting