E - the type of elements held in this deque
BlockingQueue<E>, Collection<E>, Deque<E>, Iterable<E>, Queue<E>
LinkedBlockingDeque
public interface BlockingDeque<E> extends BlockingQueue<E>, Deque<E>
A
Deque
that additionally supports blocking operations that wait for the deque to become non-empty when retrieving an element, and wait for space to become available in the deque when storing an element.
BlockingDeque methods come in four forms, with different ways of handling operations that cannot be satisfied immediately, but may be satisfied at some point in the future: one throws an exception, the second returns a special value (either null or false, depending on the operation), the third blocks the current thread indefinitely until the operation can succeed, and the fourth blocks for only a given maximum time limit before giving up. These methods are summarized in the following table:
Like any BlockingQueue, a BlockingDeque is thread safe, does not permit null elements, and may (or may not) be capacity-constrained.
A BlockingDeque implementation may be used directly as a FIFO BlockingQueue. The methods inherited from the BlockingQueue interface are precisely equivalent to BlockingDeque methods as indicated in the following table:
Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into a BlockingDeque happen-before actions subsequent to the access or removal of that element from the BlockingDeque in another thread.
This interface is a member of the Java Collections Framework.
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.
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.
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.
boolean contains(Object o)
Returns true if this deque contains the specified element.
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).
Iterator<E> iterator()
Returns an iterator over the elements in this deque in proper sequence.
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.
boolean offer(E e, long timeout, 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.
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.
boolean offerFirst(E e, long timeout, 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.
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.
boolean offerLast(E e, long timeout, 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.
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.
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 poll(long timeout, 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.
E pollFirst(long timeout, 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.
E pollLast(long timeout, 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.
void push(E 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, throwing an IllegalStateException if no space is currently available.
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.
void putFirst(E e)
Inserts the specified element at the front of this deque, waiting if necessary for space to become available.
void putLast(E e)
Inserts the specified element at the end of this deque, waiting if necessary for space to become available.
E remove()
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque).
boolean remove(Object o)
Removes the first occurrence of the specified element from this deque.
boolean removeFirstOccurrence(Object o)
Removes the first occurrence of the specified element from this deque.
boolean removeLastOccurrence(Object o)
Removes the last occurrence of the specified element from this deque.
int size()
Returns the number of elements in this deque.
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.
E takeFirst()
Retrieves and removes the first element of this deque, waiting if necessary until an element becomes available.
E takeLast()
Retrieves and removes the last element of this deque, waiting if necessary until an element becomes available.
Methods declared in interface java.util.Collectionclear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray Methods declared in interface java.util.DequeaddAll, descendingIterator, getFirst, getLast, peekFirst, peekLast, pollFirst, pollLast, pop, removeFirst, removeLastInserts 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
offerFirst
.
addFirst in interface Deque<E>
e - the element to add
IllegalStateException - if the element cannot be added at this time due to capacity restrictions
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
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
offerLast
.
addLast in interface Deque<E>
e - the element to add
IllegalStateException - if the element cannot be added at this time due to capacity restrictions
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
(
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
addFirst
method, which can fail to insert an element only by throwing an exception.
offerFirst in interface Deque<E>
e - the element to add
true if the element was added to this deque, else false
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
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
addLast
method, which can fail to insert an element only by throwing an exception.
offerLast in interface Deque<E>
e - the element to add
true if the element was added to this deque, else false
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
Inserts the specified element at the front of this deque, waiting if necessary for space to become available.
e - the element to add
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
Inserts the specified element at the end of this deque, waiting if necessary for space to become available.
e - the element to add
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
Inserts the specified element at the front of this deque, waiting up to the specified wait time if necessary for space to become available.
e - the element to add
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
true if successful, or false if the specified waiting time elapses before space is available
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
Inserts the specified element at the end of this deque, waiting up to the specified wait time if necessary for space to become available.
e - the element to add
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
true if successful, or false if the specified waiting time elapses before space is available
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
Retrieves and removes the first element of this deque, waiting if necessary until an element becomes available.
InterruptedException - if interrupted while waiting
Retrieves and removes the last element of this deque, waiting if necessary until an element becomes available.
InterruptedException - if interrupted while waiting
Retrieves and removes the first element of this deque, waiting up to the specified wait time if necessary for an element to become available.
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
null if the specified waiting time elapses before an element is available
InterruptedException - if interrupted while waiting
Retrieves and removes the last element of this deque, waiting up to the specified wait time if necessary for an element to become available.
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
null if the specified waiting time elapses before an element is available
InterruptedException - if interrupted while waiting
(
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).
removeFirstOccurrence in interface Deque<E>
o - element to be removed from this deque, if present
true if an element was removed as a result of this call
ClassCastException - if the class of the specified element is incompatible with this deque (optional)
NullPointerException - if the specified element is null (optional)
(
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).
removeLastOccurrence in interface Deque<E>
o - element to be removed from this deque, if present
true if an element was removed as a result of this call
ClassCastException - if the class of the specified element is incompatible with this deque (optional)
NullPointerException - if the specified element is null (optional)
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.
add in interface BlockingQueue<E>
add in interface Collection<E>
add in interface Deque<E>
add in interface Queue<E>
e - the element to add
true (as specified by Collection.add(E))
IllegalStateException - if the element cannot be added at this time due to capacity restrictions
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
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(E)
method, which can fail to insert an element only by throwing an exception.
This method is equivalent to offerLast.
offer in interface BlockingQueue<E>
offer in interface Deque<E>
offer in interface Queue<E>
e - the element to add
true if the element was added to this queue, else false
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
This method is equivalent to putLast.
put in interface BlockingQueue<E>
e - the element to add
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
This method is equivalent to offerLast.
offer in interface BlockingQueue<E>
e - the element to add
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
true if the element was added to this deque, else false
InterruptedException - if interrupted while waiting
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
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.
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 Deque.pollFirst().
This method is equivalent to takeFirst.
take in interface BlockingQueue<E>
InterruptedException - if interrupted while waiting
This method is equivalent to pollFirst.
poll in interface BlockingQueue<E>
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameter
null if the specified waiting time elapses before an element is available
InterruptedException - if interrupted while waiting
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.
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.
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 removeFirstOccurrence.
remove in interface BlockingQueue<E>
remove in interface Collection<E>
remove in interface Deque<E>
o - element to be removed from this deque, if present
true if this deque changed as a result of the call
ClassCastException - if the class of the specified element is incompatible with this deque (optional)
NullPointerException - if the specified element is null (optional)
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).
contains in interface BlockingQueue<E>
contains in interface Collection<E>
contains in interface Deque<E>
o - object to be checked for containment in this deque
true if this deque contains the specified element
ClassCastException - if the class of the specified element is incompatible with this deque (optional)
NullPointerException - if the specified element is null (optional)
int size()
Returns the number of elements in this deque.
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).
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, throwing an
IllegalStateException
if no space is currently available.
This method is equivalent to addFirst.
push in interface Deque<E>
e - the element to push
IllegalStateException - if the element cannot be added at this time due to capacity restrictions
ClassCastException - if the class of the specified element prevents it from being added to this deque
NullPointerException - if the specified element is null
IllegalArgumentException - if some property of the specified element prevents it from being added to this deque
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4