public abstract class

AbstractQueue

extends AbstractCollection<E>
implements Queue<E>
java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ java.util.AbstractQueue<E>
Known Direct Subclasses

Class Overview

AbstractQueue is an abstract class which implements some of the methods in Queue. The provided implementations of add, remove and element are based on offer, poll, and peek except that they throw exceptions to indicate some error instead of returning true or false.

Summary

Protected Constructors
AbstractQueue()
Constructor to be used by subclasses.
Public Methods
boolean add(E o)
Adds an element to the queue.
boolean addAll(Collection<? extends E> c)
Adds all the elements of a collection to the queue.
void clear()
Removes all elements of the queue, leaving it empty.
E element()
Returns but does not remove the element at the head of the queue.
E remove()
Removes the element at the head of the queue and returns it.
[Expand]
Inherited Methods
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface java.util.Queue

Protected Constructors

protected AbstractQueue ()

Since: API Level 1

Constructor to be used by subclasses.

Public Methods

public boolean add (E o)

Since: API Level 1

Adds an element to the queue.

Parameters
o the element to be added to the queue.
Returns
  • true if the operation succeeds, otherwise false.
Throws
IllegalStateException if the element is not allowed to be added to the queue.

public boolean addAll (Collection<? extends E> c)

Since: API Level 1

Adds all the elements of a collection to the queue. If the collection is the queue itself, then an IllegalArgumentException will be thrown. If during the process, some runtime exception is thrown, then those elements in the collection which have already successfully been added will remain in the queue. The result of the method is undefined if the collection is modified during the process of the method.

Parameters
c the collection to be added to the queue.
Returns
  • true if the operation succeeds, otherwise false.
Throws
NullPointerException if the collection or any element of it is null.
IllegalArgumentException If the collection to be added to the queue is the queue itself.

public void clear ()

Since: API Level 1

Removes all elements of the queue, leaving it empty.

public E element ()

Since: API Level 1

Returns but does not remove the element at the head of the queue.

Returns
  • the element at the head of the queue.
Throws
NoSuchElementException if the queue is empty.

public E remove ()

Since: API Level 1

Removes the element at the head of the queue and returns it.

Returns
  • the element at the head of the queue.
Throws
NoSuchElementException if the queue is empty.