クラスAbstractQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

型パラメータ:

E - このキューに保持されている要素の型

すべての実装されたインタフェース:

Iterable<E>, Collection<E>, Queue<E>

直系の既知のサブクラス:

ArrayBlockingQueue, ConcurrentLinkedQueue, DelayQueue, LinkedBlockingDeque, LinkedBlockingQueue, LinkedTransferQueue, PriorityBlockingQueue, PriorityQueue, SynchronousQueue

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

このクラスは、Queueのいくつかのオペレーションのスケルトン実装を提供します。 このクラスの実装は、ベース実装でnull要素が許可されていない場合に適しています。 メソッドadd、removeおよびelementは、それぞれoffer、pollおよびpeekに基づいていますが、falseまたはnullを介した失敗を示すかわりに例外をスローします。

このクラスを拡張するQueue実装では、null要素を挿入できないメソッドQueue.offer(E)を、Queue.peek()、Queue.poll()、Collection.size()およびCollection.iterator()メソッドとともに最小限定義する必要があります。 通常、追加メソッドもオーバーライドされます。 これらの要件を満たすことができない場合、AbstractCollectionのサブクラス化を考慮してください。

このクラスは、Java Collections Frameworkのメンバーです。

導入されたバージョン:

1.5

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタ	説明
protected	AbstractQueue()	サブクラスにより使用されるコンストラクタです。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(E e)	容量制限に違反することなく、指定された要素をこのキューにすぐに挿入できる場合はそうします。成功した場合はtrueを返し、その時点で使用可能な空き領域が存在しない場合はIllegalStateExceptionをスローします。
boolean	addAll(Collection<? extends E> c)	指定されたコレクション内のすべての要素をこのキューに追加します。
void	clear()	すべての要素をキューから削除します。
E	element()	キューの先頭を取得しますが、削除しません。
E	remove()	キューの先頭を取得および削除します。

クラスで宣言されたメソッド AbstractCollection

contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, toArray, toArray, toString

修飾子と型	メソッド	説明
boolean	contains(Object o)	このコレクションに指定した要素が含まれている場合は、trueを返します。
boolean	containsAll(Collection<?> c)	指定したコレクションのすべての要素がこのコレクションに含まれている場合、trueを返します。
boolean	isEmpty()	このコレクションに要素がない場合にtrueを返します。
abstract Iterator<E>	iterator()	このコレクション中の要素に関係するイテレータを返します。
boolean	remove(Object o)	指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから1つ削除します(オプションの操作)。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
Object[]	toArray()	このコレクションの要素がすべて格納されている配列を返します。
<T> T[]	toArray(T[] a)	このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。
String	toString()	このコレクションの文字列表現を返します。

クラスオブジェクトで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

修飾子と型	メソッド	説明
protected Object	clone()	このオブジェクトのコピーを作成して、返します。
boolean	equals(Object obj)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
protected void	finalize()	削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。 最終決定は非推奨であり、将来のリリースで削除される可能性があります。
final Class<?>	getClass()	このObjectの実行時クラスを返します。
int	hashCode()	このオブジェクトに対するハッシュ・コード値を返します。
final void	notify()	このオブジェクトのモニターで待機中のスレッドを1つ再開します。
final void	notifyAll()	このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
final void	wait()	現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
final void	wait(long timeoutMillis)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
final void	wait(long timeoutMillis, int nanos)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

インタフェースCollectionで宣言されたメソッド

equals, hashCode, parallelStream, removeIf, size, spliterator, stream, toArray

修飾子と型	メソッド	説明
boolean	equals(Object o)	指定されたオブジェクトとこのコレクションが等しいかどうかを比較します。
int	hashCode()	コレクションのハッシュ・コード値を返します。
default Stream<E>	parallelStream()	このコレクションをソースとして、潜在的に並列のStreamを返します。
default boolean	removeIf(Predicate<? super E> filter)	指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。
int	size()	このコレクション中の要素の数を返します。
default Spliterator<E>	spliterator()	このコレクション内の要素に対するSpliteratorを作成します。
default Stream<E>	stream()	このコレクションをソースとして使用して、逐次的なStreamを返します。
default <T> T[]	toArray(IntFunction<T[]> generator)	指定されたgenerator関数を使用してこのコレクションのすべての要素を含む配列を返し、返された配列を割り当てます。

インタフェースIterableで宣言されたメソッド

forEach

修飾子と型	メソッド	説明
default void	forEach(Consumer<? super E> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。

インタフェースキューで宣言されたメソッド

offer, peek, poll

修飾子と型	メソッド	説明
boolean	offer(E e)	容量制限に違反せずにすぐ実行できる場合は、指定された要素をこのキューに挿入します。
E	peek()	キューの先頭を取得しますが、削除しません。キューが空の場合はnullを返します。
E	poll()	キューの先頭を取得および削除します。キューが空の場合はnullを返します。

コンストラクタの詳細

AbstractQueue

protected AbstractQueue()

サブクラスにより使用されるコンストラクタです。

メソッドの詳細

add

public boolean add(E e)

容量制限に違反することなく、指定された要素をこのキューにすぐに挿入できる場合はそうします。成功した場合はtrueを返し、その時点で使用可能な空き領域が存在しない場合はIllegalStateExceptionをスローします。

この実装は、offerが成功した場合はtrueを返し、成功しなかった場合はIllegalStateExceptionをスローします。

定義:

add、インタフェースCollection<E>

定義:

add、インタフェースQueue<E>

オーバーライド:

add、クラスAbstractCollection<E>

パラメータ:

e - 追加する要素

戻り値:

true (Collection.add(E)で指定されているとおり)

スロー:

IllegalStateException - 容量制限のために、この時点で要素を追加できない場合

ClassCastException - 指定された要素のクラスが原因で、このキューにその要素を追加できない場合

NullPointerException - 指定された要素がnullで、このキューがnull要素を許可しない場合

IllegalArgumentException - この要素のあるプロパティが原因で、このキューにその要素を追加できない場合

remove

public E remove()

キューの先頭を取得および削除します。 このメソッドは、キューが空の場合に例外をスローする点のみがpollメソッドと異なります。

この実装では、キューが空でないかぎり、pollの結果が返されます。

定義:

remove、インタフェースQueue<E>

戻り値:

キューの先頭

スロー:

NoSuchElementException - このキューが空の場合

element

public E element()

キューの先頭を取得しますが、削除しません。 このメソッドは、キューが空の場合に例外をスローする点のみがpeekメソッドと異なります。

この実装では、キューが空でないかぎり、peekの結果が返されます。

定義:

element、インタフェースQueue<E>

戻り値:

キューの先頭

スロー:

NoSuchElementException - このキューが空の場合

clear

public void clear()

すべての要素をキューから削除します。 この呼出しが戻ると、キューは空になります。

この実装では、nullが返されるまでpollを繰り返し起動します。

定義:

clear、インタフェースCollection<E>

オーバーライド:

clear、クラスAbstractCollection<E>

addAll

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

指定されたコレクション内のすべての要素をこのキューに追加します。 キューのaddAllをそれ自体に対して試行すると、IllegalArgumentExceptionになります。 また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

この実装は、指定されたコレクションに対して処理を繰返し実行し、イテレータにより返される各要素をこのキューに順番に追加します。 要素(null要素を含めます)を追加しようとしているときにランタイム例外が発生すると、関連する例外がスローされたときに正常に追加された要素の一部のみが発生する可能性があります。

定義:

addAll、インタフェースCollection<E>

オーバーライド:

addAll、クラスAbstractCollection<E>

パラメータ:

c - キューに追加される要素を含むコレクション

戻り値:

この呼出しの結果、このキューが変更された場合はtrue

スロー:

ClassCastException - i指定されたコレクションの要素のクラスが原因で、このキューに追加できなかった場合

NullPointerException - 指定されたコレクション内にnull要素が含まれ、このキューがnull要素を許可しない場合。または指定されたコレクションがnullの場合

IllegalArgumentException - 指定されたコレクションの要素のある特性が原因で、このキューに要素を追加できなかった場合。または指定されたコレクションがこのキューの場合

IllegalStateException - 挿入制限のため、この時点で一部の要素を追加できない場合

関連項目:

• add(Object)