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、removeAll、retainAll、containsAll、equals、および toArray の一括オペレーションについて、原子的な実行は保証されていません。たとえば、addAll オペレーションと並行して動作するイテレータは、追加された要素の一部しか表示しないことがあります。

このクラスとそのイテレータは、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) 指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でこのキューの最後に追加します。
boolean	contains(Object o) 指定された要素がキューに含まれている場合に true を返します。
boolean	isEmpty() キューに要素がない場合に true を返します。
Iterator<E>	iterator() このキュー内の要素を適切な順序で反復処理するイテレータを返します。
boolean	offer(E e) キューの末尾に、指定された要素を挿入します。
E	peek() このキューの先頭を取得しますが、削除しません。キューが空の場合は null を返します。
E	poll() このキューの先頭を取得および削除します。キューが空の場合は null を返します。
boolean	remove(Object o) 指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
int	size() キュー内にある要素の数を返します。
Object[]	toArray() キュー内のすべての要素を適切な順序で含む配列を返します。
<T> T[]	toArray(T[] a) キュー内のすべての要素を適切な順序で含む配列を返します。返される配列の実行時の型は、指定された配列の型になります。

クラス java.util.AbstractQueue から継承されたメソッド

clear, element, remove

クラス java.util.AbstractCollection から継承されたメソッド

containsAll, removeAll, retainAll, toString

クラス java.lang.Object から継承されたメソッド

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

インタフェース java.util.Queue から継承されたメソッド

element, remove

インタフェース java.util.Collection から継承されたメソッド

clear, containsAll, equals, hashCode, removeAll, retainAll

コンストラクタの詳細

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>

定義:

size、クラス: AbstractCollection<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>

パラメータ:

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

戻り値:

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

例外:

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

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

iterator

public Iterator<E> iterator()

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

返されるイテレータは「弱一貫性」を持つイテレータであり、ConcurrentModificationException をスローすることはなく、イテレータの構築時に存在した要素をトラバースすることを保証します。また、構築後のすべての変更を反映します (ただし保証されてはいない)。

定義:

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

定義:

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

定義:

iterator、クラス: AbstractCollection<E>

戻り値:

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