E
- the type of elements held in this queue
Iterable<E>
, Collection<E>
, Queue<E>
ArrayBlockingQueue
, ConcurrentLinkedQueue
, DelayQueue
, LinkedBlockingDeque
, LinkedBlockingQueue
, LinkedTransferQueue
, PriorityBlockingQueue
, PriorityQueue
, SynchronousQueue
This class provides skeletal implementations of some
Queue
operations. The implementations in this class are appropriate when the base implementation does
notallow
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.
Constructors
protected
Constructor for use by subclasses.
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.
Methods declared in interface java.util.Collectioncontains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray
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
.
add
in interface Collection<E>
add
in interface Queue<E>
add
in class AbstractCollection<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 queue
NullPointerException
- if the specified element is null and this queue does not permit null elements
IllegalArgumentException
- if some property of this element prevents it from being added to this queue
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.
remove
in interface Queue<E>
NoSuchElementException
- if this queue is empty
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.
element
in interface Queue<E>
NoSuchElementException
- if this queue is empty
public void clear()
This implementation repeatedly invokes poll
until it returns null
.
clear
in interface Collection<E>
clear
in class AbstractCollection<E>
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.
addAll
in interface Collection<E>
addAll
in class AbstractCollection<E>
c
- collection containing elements to be added to this queue
true
if this queue changed as a result of the call
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
IllegalStateException
- if not all the elements can be added at this time due to insertion restrictions
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