AbstractQueue

java.lang.Object

|---java.util.AbstractCollection<E&

|---|---java.util.AbstractQueue<E&

public abstract class AbstractQueue<E>
extends AbstractCollection<E>
implements Queue<E>

这个类提供了一些 Queue 操作的骨架实现。 当基本实现不允许空元素时，此类中的实现是合适的。 add、remove 和 element 方法分别基于 offer、poll 和 peek，但会抛出异常，而不是通过 false 或 null 返回来指示失败。

扩展此类的 Queue 实现必须至少定义一个不允许插入空元素的方法 Queue#offer，以及方法 Queue#peek、Queue#poll、Collection#size 和 Collection#iterator。 通常，其他方法也会被覆盖。 如果无法满足这些要求，请考虑将 AbstractCollection 子类化。

此类是 Java 集合框架的成员。

构造函数摘要

修饰符	构造函数	描述
protected	AbstractQueue()	子类使用的构造函数。

方法总结

修饰符和类型	方法	描述
boolean	add(E e)	如果可以在不违反容量限制的情况下立即将指定元素插入此队列，则在成功时返回 true，如果当前没有可用空间则抛出 IllegalStateException。
boolean	addAll(Collection<? extends E> c)	将指定集合中的所有元素添加到此队列。
void	clear()	从此队列中删除所有元素。
E	element()	检索但不删除此队列的头部。
E	remove()	检索并删除此队列的头部。

从类 java.util.AbstractCollection 继承的方法
contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

从接口 java.util.Collection 继承的方法
contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

从接口 java.lang.Iterable 继承的方法
forEach

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口 java.util.Queue 继承的方法
offer, peek, poll

构造函数详细信息

AbstractQueue

protected AbstractQueue()

子类使用的构造函数。

方法详情

add

public boolean add(E e)

如果可以在不违反容量限制的情况下立即将指定元素插入此队列，则在成功时返回 true，如果当前没有可用空间则抛出 IllegalStateException。

如果 offer 成功，此实现返回 true，否则抛出 IllegalStateException。

指定者：

添加接口CollectionE

指定者：

添加接口QueueE

覆盖：

添加类 AbstractCollectionE

参数：

参数名称	参数描述
e	要添加的元素

返回:

true（由 Collection#add 指定）

Throws:

Throw名称	Throw描述
IllegalStateException	如果此时由于容量限制无法添加元素
ClassCastException	如果指定元素的类阻止它被添加到这个队列
NullPointerException	如果指定元素为空且此队列不允许空元素
IllegalArgumentException	如果此元素的某些属性阻止它被添加到此队列中

remove

public E remove()

检索并删除此队列的头部。 此方法与 poll 的不同之处仅在于如果此队列为空，它将引发异常。

此实现返回 poll 的结果，除非队列为空。

指定者：

在接口 QueueE 中删除

返回:

这个队列的头

Throws:

Throw名称	Throw描述
NoSuchElementException	如果此队列为空

element

public E element()

检索但不删除此队列的头部。 此方法与 peek 的不同之处仅在于如果此队列为空，它将引发异常。

此实现返回 peek 的结果，除非队列为空。

指定者：

接口 QueueE 中的元素

返回:

这个队列的头

Throws:

Throw名称	Throw描述
NoSuchElementException	如果此队列为空

clear

public void clear()

从此队列中删除所有元素。 此调用返回后，队列将为空。

此实现重复调用 poll 直到它返回 null。

指定者：

在界面 CollectionE 中清除

覆盖：

在类 AbstractCollectionE 中清除

addAll

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

将指定集合中的所有元素添加到此队列。 尝试将队列的所有内容添加到自身会导致 IllegalArgumentException。 此外，如果在操作正在进行时修改了指定的集合，则此操作的行为是未定义的。

此实现迭代指定的集合，并将迭代器返回的每个元素依次添加到此队列中。 尝试添加元素（尤其包括空元素）时遇到的运行时异常可能会导致在引发相关异常时只有部分元素已成功添加。

指定者：

接口 CollectionE 中的 addAll

覆盖：

类 AbstractCollectionE 中的 addAll

参数：

参数名称	参数描述
c	包含要添加到此队列的元素的集合

返回:

如果此队列因调用而更改，则为 true

Throws:

Throw名称	Throw描述
ClassCastException	如果指定集合的元素的类阻止它被添加到此队列
NullPointerException	如果指定的集合包含空元素并且此队列不允许空元素，或者指定的集合为空
IllegalArgumentException	如果指定集合的元素的某些属性阻止它被添加到此队列，或者指定集合是此队列
IllegalStateException	如果由于插入限制，此时不能添加所有元素