|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class AbstractQueue<E>
java.util.AbstractQueue<E>
Type Parameters:
E - the type of elements held in this queue
All Implemented Interfaces:
Direct Known Subclasses:
public abstract class AbstractQueue<E>
This class provides skeletal implementations of some
Queue
operations. The implementations in this class are appropriate when
the base implementation does
not allow
null
elements. Methods
add,
remove, and
element are based on
offer,
poll, and
peek, respectively, but throw
exceptions instead of indicating failure via
false or
null returns.
A Queue implementation that extends this class must
minimally define a method Queue.offer(E) which does not permit
insertion of null elements, along with methods Queue.peek(), Queue.poll(), Collection.size(), and
Collection.iterator(). Typically, additional methods will be
overridden as well. If these requirements cannot be met, consider
instead subclassing AbstractCollection.
This class is a member of the
Java Collections Framework.
Since:
1.5
Author:
Doug Lea
Constructor Summary |
protected |
Constructor for use by subclasses.
|
Method Summary |
boolean |
Inserts the specified element into this queue 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.
|
boolean |
Adds all of the elements in the specified collection to this
queue.
|
void |
Removes all of the elements from this queue.
|
|
Retrieves, but does not remove, the head of this queue.
|
|
Retrieves and removes the head of this queue.
|
|
contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from class java.lang. Object |
|
Methods inherited from interface java.util. Collection |
|
Methods inherited from interface java.lang. Iterable |
|
Methods inherited from interface java.util. Queue |
|
protected AbstractQueue |
() |
Constructor for use by subclasses.
Inserts the specified element into this queue 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 implementation returns true if offer succeeds,
else throws an IllegalStateException.
Specified by:
Overrides:
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 queue
NullPointerException - if the specified element is null and
this queue does not permit null elements
Retrieves and removes the head of this queue. This method differs
from
poll only in that it throws an exception if this
queue is empty.
This implementation returns the result of poll
unless the queue is empty.
Specified by:
Returns:
the head of this queue
Throws:
Retrieves, but does not remove, the head of this queue. This method
differs from
peek only in that it throws an exception if
this queue is empty.
This implementation returns the result of peek
unless the queue is empty.
Specified by:
Returns:
the head of this queue
Throws:
Removes all of the elements from this queue.
The queue will be empty after this call returns.
This implementation repeatedly invokes poll until it
returns null.
Specified by:
Overrides:
Adds all of the elements in the specified collection to this
queue. Attempts to addAll of a queue to itself result in
IllegalArgumentException. Further, the behavior of
this operation is undefined if the specified collection is
modified while the operation is in progress.
This implementation iterates over the specified collection,
and adds each element returned by the iterator to this
queue, in turn. A runtime exception encountered while
trying to add an element (including, in particular, a
null element) may result in only some of the elements
having been successfully added when the associated exception is
thrown.
Specified by:
Overrides:
Parameters:
c - collection containing elements to be added to this queue
Returns:
true if this queue changed as a result of the call
Throws:
ClassCastException - if the class of an element of the specified
collection prevents it from being added to this queue
NullPointerException - if the specified collection contains a
null element and this queue does not permit null elements,
or if the specified collection is null
IllegalArgumentException - if some property of an element of the
specified collection prevents it from being added to this
queue, or if the specified collection is this queue
See Also:
|
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