|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Interface BlockingDeque<E>
Type Parameters:
E - the type of elements held in this deque
All Superinterfaces:
All Known Implementing Classes:
public interface BlockingDeque<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.
Since:
1.6
Author:
Doug Lea
Method Summary |
boolean |
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 |
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 |
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 |
Returns true if this deque contains the specified element.
|
|
Retrieves, but does not remove, the head of the queue represented by
this deque (in other words, the first element of this deque).
|
|
Returns an iterator over the elements in this deque in proper sequence.
|
boolean |
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 |
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 |
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 |
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 |
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 |
Inserts the specified element at the end of this deque,
waiting up to the specified wait time if necessary for space to
become available.
|
|
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.
|
|
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.
|
|
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.
|
|
Retrieves and removes the first element of this deque, waiting
up to the specified wait time if necessary for an element to
become available.
|
|
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 |
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 |
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 |
Inserts the specified element at the front of this deque,
waiting if necessary for space to become available.
|
void |
Inserts the specified element at the end of this deque,
waiting if necessary for space to become available.
|
|
Retrieves and removes the head of the queue represented by this deque
(in other words, the first element of this deque).
|
boolean |
Removes the first occurrence of the specified element from this deque.
|
boolean |
Removes the first occurrence of the specified element from this deque.
|
boolean |
Removes the last occurrence of the specified element from this deque.
|
int |
Returns the number of elements in this deque.
|
|
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.
|
|
Retrieves and removes the first element of this deque, waiting
if necessary until an element becomes available.
|
|
Retrieves and removes the last element of this deque, waiting
if necessary until an element becomes available.
|
Methods inherited from interface java.util.concurrent. BlockingQueue |
|
Methods inherited from interface java.util. Collection |
addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray |
Methods inherited from interface java.lang. Iterable |
|
Methods inherited from interface java.util. Deque |
|
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
offerFirst.
Specified by:
Parameters:
e - the element to add
Throws:
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
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.
Specified by:
Parameters:
e - the element to add
Throws:
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
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.
Specified by:
Parameters:
e - the element to add
Returns:
true if the element was added to this deque, else
false
Throws:
ClassCastException - if the class 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.
Specified by:
Parameters:
e - the element to add
Returns:
true if the element was added to this deque, else
false
Throws:
ClassCastException - if the class 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.
Parameters:
e - the element to add
Throws:
Inserts the specified element at the end of this deque,
waiting if necessary for space to become available.
Parameters:
e - the element to add
Throws:
boolean offerFirst |
|
throws |
|
Inserts the specified element at the front of this deque,
waiting up to the specified wait time if necessary for space to
become available.
Parameters:
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
Returns:
true if successful, or false if
the specified waiting time elapses before space is available
Throws:
Inserts the specified element at the end of this deque,
waiting up to the specified wait time if necessary for space to
become available.
Parameters:
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
Returns:
true if successful, or false if
the specified waiting time elapses before space is available
Throws:
Retrieves and removes the first element of this deque, waiting
if necessary until an element becomes available.
Returns:
the head of this deque
Throws:
Retrieves and removes the last element of this deque, waiting
if necessary until an element becomes available.
Returns:
the tail of this deque
Throws:
Retrieves and removes the first element of this deque, waiting
up to the specified wait time if necessary for an element to
become available.
Parameters:
timeout - how long to wait before giving up, in units of
unit
unit - a TimeUnit determining how to interpret the
timeout parameter
Returns:
the head of this deque, or null if the specified
waiting time elapses before an element is available
Throws:
Retrieves and removes the last element of this deque, waiting
up to the specified wait time if necessary for an element to
become available.
Parameters:
timeout - how long to wait before giving up, in units of
unit
unit - a TimeUnit determining how to interpret the
timeout parameter
Returns:
the tail of this deque, or null if the specified
waiting time elapses before an element is available
Throws:
boolean removeFirstOccurrence |
|
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).
Specified by:
Parameters:
o - element to be removed from this deque, if present
Returns:
true if an element was removed as a result of this call
Throws:
boolean removeLastOccurrence |
|
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).
Specified by:
Parameters:
o - element to be removed from this deque, if present
Returns:
true if an element was removed as a result of this call
Throws:
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.
Specified by:
Parameters:
e - the element to add
Returns:
Throws:
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
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.
Specified by:
Parameters:
e - the element to add
Returns:
true if the element was added to this queue, else
false
Throws:
ClassCastException - if the class 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), waiting if necessary for
space to become available.
This method is equivalent to putLast.
Specified by:
Parameters:
e - the element to add
Throws:
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
offerLast.
Specified by:
Parameters:
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
Returns:
true if the element was added to this deque, else
false
Throws:
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.
Specified by:
Returns:
the head of the queue represented by this deque
Throws:
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().
Specified by:
Returns:
the head of this deque, or null if this deque is empty
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 takeFirst.
Specified by:
Returns:
the head of this deque
Throws:
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
pollFirst.
Specified by:
Parameters:
timeout - how long to wait before giving up, in units of
unit
unit - a TimeUnit determining how to interpret the
timeout parameter
Returns:
the head of this deque, or null if the
specified waiting time elapses before an element is available
Throws:
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.
Specified by:
Returns:
the head of this deque
Throws:
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.
Specified by:
Returns:
the head of this deque, or null if this deque is empty
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.
Specified by:
Parameters:
o - element to be removed from this deque, if present
Returns:
true if this deque changed as a result of the call
Throws:
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:
Parameters:
o - object to be checked for containment in this deque
Returns:
true if this deque contains the specified element
Throws:
Returns the number of elements in this deque.
Specified by:
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).
Specified by:
Returns:
an iterator over the elements in this deque in proper sequence
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.
Specified by:
Parameters:
e - the element to push
Throws:
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
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz