モジュール java.base

パッケージ java.util.concurrent

クラスConcurrentLinkedQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.ConcurrentLinkedQueue<E>

型パラメータ:

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

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

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

public class ConcurrentLinkedQueue<E> extends AbstractQueue<E> implements Queue<E>, Serializable

リンク・ノードに基づく、制限なしのスレッドセーフなキューです。 このキューはFIFO (先入れ先出し)で要素を順序付けします。 このキューの先頭は、キューに入っていた時間がもっとも長い要素です。 このキューの末尾は、キューに入っていた時間がもっとも短い要素です。 新しい要素はキューの末尾に挿入され、キュー取得オペレーションにより、キューの先頭の要素が取得されます。 共通のコレクションへのアクセスを多数のスレッドが共有する場合、ConcurrentLinkedQueueは選択肢として適切です。 大半のコレクション実装と同様、このクラスはnull要素の使用を許容しません。

この実装では、効率のよい非ブロックのアルゴリズムが使用されます。このアルゴリズムは次の資料で記述されているものに基づきます: 「Simple, Fast, and Practical Non-Blocking and Blocking Concurrent Queue Algorithms」Maged M. Michael、Michael L. Scott

イテレータは弱一貫性を持ち、ある時点での、またはイテレータの作成以降のキューの状態を反映する要素を返します。 これらはConcurrentModificationExceptionをスローせず、ほかのオペレーションとの並行処理が可能です。 イテレータの作成以降にキューに含まれた要素が1回だけ返されます。

大半のコレクションとは異なり、sizeメソッドは一定時間のオペレーションではないことに留意してください。 これらのキューには非同期という特性があるため、現在の要素数を判定するには要素全体をトラバースする必要があります。したがって、このコレクションがトラバーサル中に変更された場合、不正確な結果が報告されることがあります。

addAll(java.util.Collection<? extends E>)、removeIf(java.util.function.Predicate<? super E>)、forEach(java.util.function.Consumer<? super E>)など、複数の要素を追加、削除または検査するバルク操作は、原子的に実行される保証はありません。 たとえば、 addAll操作と並行するforEachトラバースでは、追加された要素の一部のみが監視される場合があります。

このクラスとそのイテレータは、QueueおよびIteratorインタフェースのオプション・メソッドすべてを実装します。

メモリー整合性効果: ほかの並行処理コレクションと同様、オブジェクトをConcurrentLinkedQueueに配置する前のスレッド内のアクションは、別のスレッドでのその要素へのアクセスまたはConcurrentLinkedQueueからの削除に続くアクションよりも前に発生します。

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

導入されたバージョン:

1.5

関連項目:

• 直列化された形式

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

コンストラクタ

コンストラクタ	説明
ConcurrentLinkedQueue()	ConcurrentLinkedQueueを作成します。これは最初は空です。
ConcurrentLinkedQueue(Collection<? extends E> c)	指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加) ConcurrentLinkedQueueを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(E e)	キューの末尾に、指定された要素を挿入します。
boolean	addAll(Collection<? extends E> c)	指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でこのキューの最後に追加します。
void	clear()	すべての要素をキューから削除します。
boolean	contains(Object o)	指定された要素がキューに含まれている場合にtrueを返します。
void	forEach(Consumer<? super E> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。
boolean	isEmpty()	キューに要素がない場合にtrueを返します。
Iterator<E>	iterator()	このキュー内の要素を適切な順序で反復処理するイテレータを返します。
boolean	offer(E e)	キューの末尾に、指定された要素を挿入します。
E	peek()	キューの先頭を取得しますが、削除しません。キューが空の場合はnullを返します。
E	poll()	キューの先頭を取得および削除します。キューが空の場合はnullを返します。
boolean	remove(Object o)	指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
boolean	removeAll(Collection<?> c)	指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
boolean	removeIf(Predicate<? super E> filter)	指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。
boolean	retainAll(Collection<?> c)	このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
int	size()	キュー内にある要素の数を返します。
Spliterator<E>	spliterator()	このキュー内の要素に対するSpliteratorを返します。
Object[]	toArray()	キュー内のすべての要素を適切な順序で含む配列を返します。
<T> T[]	toArray(T[] a)	キュー内のすべての要素を適切な順序で含む配列を返します。返される配列の実行時の型は、指定された配列の型になります。

クラスjava.util.AbstractQueueで宣言されたメソッド

clear, element, remove

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

containsAll, toString

クラスjava.lang.Objectで宣言されたメソッド

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

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

containsAll, equals, hashCode, parallelStream, stream, toArray

インタフェースjava.util.Queueで宣言されたメソッド

element, remove

コンストラクタの詳細

ConcurrentLinkedQueue

public ConcurrentLinkedQueue()

ConcurrentLinkedQueueを作成します。これは最初は空です。

ConcurrentLinkedQueue

public ConcurrentLinkedQueue(Collection<? extends E> c)

指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加) ConcurrentLinkedQueueを作成します。

パラメータ:

c - 初期状態で含む要素のコレクション

例外:

NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合

メソッドの詳細

add

public boolean add(E e)

キューの末尾に、指定された要素を挿入します。 キューがアンバウンド形式であるため、このメソッドはIllegalStateExceptionをスローしないか、falseを返します。

定義:

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

定義:

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

オーバーライド:

add、クラスAbstractQueue<E>

パラメータ:

e - 追加する要素

戻り値:

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

例外:

NullPointerException - 指定された要素がnullである場合

offer

public boolean offer(E e)

キューの末尾に、指定された要素を挿入します。 キューがアンバウンド形式であるため、このメソッドはfalseを返しません。

定義:

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

パラメータ:

e - 追加する要素

戻り値:

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

例外:

NullPointerException - 指定された要素がnullである場合

poll

public E poll()

インタフェースからコピーされた説明: Queue

キューの先頭を取得および削除します。キューが空の場合はnullを返します。

定義:

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

戻り値:

キューの先頭。キューが空の場合はnull

peek

public E peek()

インタフェースからコピーされた説明: Queue

キューの先頭を取得しますが、削除しません。キューが空の場合はnullを返します。

定義:

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

戻り値:

キューの先頭。キューが空の場合はnull

isEmpty

public boolean isEmpty()

キューに要素がない場合にtrueを返します。

定義:

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

オーバーライド:

isEmpty、クラスAbstractCollection<E>

戻り値:

キューに要素がない場合はtrue

size

public int size()

キュー内にある要素の数を返します。 このキューにInteger.MAX_VALUEより多くの要素がある場合は、Integer.MAX_VALUEを返します。

大半のコレクションとは異なり、このメソッドは一定時間のオペレーションではないことに留意してください。 これらのキューには非同期という特性があるため、現在の要素数を判定するにはO(n)トラバーサルが必要です。 さらに、このメソッドの実行中に要素が追加または削除された場合は、返される結果が不正確になることがあります。 そのため、このメソッドは、通常は並行処理アプリケーションではあまり便利ではありません。

定義:

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

戻り値:

キューの要素数

contains

public boolean contains(Object o)

指定された要素がキューに含まれている場合にtrueを返します。 つまり、このキュー内にo.equals(e)のような1つ以上の要素eが含まれている場合、trueを返します。

定義:

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

オーバーライド:

contains、クラスAbstractCollection<E>

パラメータ:

o - このキューに含まれているかどうかを調べるオブジェクト

戻り値:

指定された要素がこのキューに含まれている場合はtrue

remove

public boolean remove(Object o)

指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。 つまり、キュー内に、o.equals(e)に該当する要素eが1つ以上含まれている場合は、そのような要素を削除します。 指定された要素がこのキューに含まれていた場合、つまり、呼出しの結果としてこのキューが変更された場合にtrueを返します。

定義:

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

オーバーライド:

remove、クラスAbstractCollection<E>

パラメータ:

o - キューから削除される要素(その要素が存在する場合)

戻り値:

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

addAll

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

指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でこのキューの最後に追加します。 キューをそれ自体に対してaddAllしようとすると、IllegalArgumentExceptionが発生します。

定義:

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

オーバーライド:

addAll、クラスAbstractQueue<E>

パラメータ:

c - このキューに挿入される要素

戻り値:

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

例外:

NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合

IllegalArgumentException - コレクションがこのキューである場合

関連項目:

• AbstractQueue.add(Object)

toArray

public Object[] toArray()

キュー内のすべての要素を適切な順序で含む配列を返します。

返される配列は、それへの参照がこのキューで保持されない場合に、安全になります。 (つまり、このメソッドは新しい配列を割り当てます)。 このため、呼出し側は、返された配列を自由に変更できます。

このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。

定義:

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

オーバーライド:

toArray、クラスAbstractCollection<E>

戻り値:

このキューのすべての要素が含まれている配列

toArray

public <T> T[] toArray(T[] a)

キュー内のすべての要素を適切な順序で含む配列を返します。返される配列の実行時の型は、指定された配列の型になります。 キューが指定された配列に収まる場合は、その中に返されます。 そうでない場合は、指定された配列の実行時の型とキューのサイズを持つ新しい配列が割り当てられます。

キューが指定された配列に収まり、その配列にさらに余裕がある場合(つまり、配列がキューより多くの要素を持つ場合)、その配列内でキューの終端よりあとの要素はnullに設定されます。

toArray()メソッドと同じように、このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。 さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割当ての手間を抑えるために使用できます。

xが、文字列だけからなるキューであることがわかっていると仮定します。 次のコードを使うと、新しく割り当てられたStringの配列にキューをダンプできます。

 String[] y = x.toArray(new String[0]);

toArray(new Object[0])は、機能の点でtoArray()と同一です。

定義:

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

オーバーライド:

toArray、クラスAbstractCollection<E>

型パラメータ:

T - コレクションを格納する配列のコンポーネント型

パラメータ:

a - 配列が十分な大きさを持つ場合は、キューの要素が格納される配列。そうでない場合は、要素を格納するために同じ実行時の型の新しい配列が割り当てられる

戻り値:

このキューのすべての要素が含まれている配列

例外:

ArrayStoreException - 指定された配列の実行時の型が、このキュー内の各要素の実行時の型のスーパー・タイプでない場合

NullPointerException - 指定された配列がnullである場合

iterator

public Iterator<E> iterator()

このキュー内の要素を適切な順序で反復処理するイテレータを返します。 要素は最初(先頭)から最後(末尾)の順に返されます。

返されるイテレータは弱一貫性を保持します。

定義:

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

定義:

iterator、インタフェースIterable<E>

定義:

iterator、クラスAbstractCollection<E>

戻り値:

キュー内の要素を適切な順序で繰返し処理するイテレータ

spliterator

public Spliterator<E> spliterator()

このキュー内の要素に対するSpliteratorを返します。

返されるスプリッテレータは弱一貫性を保持します。

Spliteratorは、Spliterator.CONCURRENT、Spliterator.ORDEREDおよびSpliterator.NONNULLを報告します。

定義:

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

定義:

spliterator、インタフェースIterable<E>

実装上のノート:

Spliteratorは、制限付きの並列処理を許可するためにtrySplitを実装します。

戻り値:

このキュー内の要素に対するSpliterator

導入されたバージョン:

1.8

removeIf

public boolean removeIf(Predicate<? super E> filter)

次のインタフェースからコピーされた説明: Collection

指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。 反復中に、または述語によってスローされたエラーまたは実行時例外は、呼出し側に中継されます。

定義:

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

パラメータ:

filter - 削除される要素に対してtrueを返す述語

戻り値:

要素が削除された場合はtrue

例外:

NullPointerException - 指定されたフィルタがnullである場合

removeAll

public boolean removeAll(Collection<?> c)

次のクラスからコピーされた説明: AbstractCollection

指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。 この呼出しの結果、このコレクションには指定されたコレクションと共通の要素はなくなります。

定義:

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

オーバーライド:

removeAll、クラスAbstractCollection<E>

パラメータ:

c - このコレクションから削除される要素を含むコレクション

戻り値:

コールの結果としてこのコレクションが変更された場合、true

例外:

NullPointerException - このコレクションに1つ以上のnull要素が含まれ、指定したコレクションがnull要素(optional)をサポートしていない場合、または指定されたコレクションがnullの場合

関連項目:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

次のクラスからコピーされた説明: AbstractCollection

このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。 つまり、指定されたコレクションに格納されていないすべての要素をこのコレクションから削除します。

定義:

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

オーバーライド:

retainAll、クラスAbstractCollection<E>

パラメータ:

c - このコレクションで保持される要素を含むコレクション

戻り値:

コールの結果としてこのコレクションが変更された場合、true

例外:

NullPointerException - このコレクションに1つ以上のnull要素が含まれ、指定したコレクションでnull要素(optional)が許可されていない場合、または指定されたコレクションがnullの場合

関連項目:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)

clear

public void clear()

クラス: AbstractQueueからコピーされた説明

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

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

定義:

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

オーバーライド:

clear、クラスAbstractQueue<E>

forEach

public void forEach(Consumer<? super E> action)

インタフェースからコピーされた説明: Iterable

Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。

このメソッドの動作は、オーバーライドするクラスが同時変更ポリシーを指定していないかぎり、要素の基礎となるソースを変更する副作用をアクションが実行する場合には指定されません。

定義:

forEach、インタフェースIterable<E>

パラメータ:

action - 各要素に対して実行されるアクション

例外:

NullPointerException - 指定されたアクションがnullである場合