java.util.concurrent

クラス LinkedTransferQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.LinkedTransferQueue<E>

型パラメータ:

E - このコレクション内に保持される要素の型

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

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

public class LinkedTransferQueue<E>
extends AbstractQueue<E>
implements TransferQueue<E>, Serializable

リンクノードに基づく、制限なしの TransferQueue です。このキューは、指定された任意のプロデューサに関して、FIFO (先入れ先出し) で要素を順序付けします。キューの先頭は、特定のプロデューサに関して、もっとも長い時間キューに入っていた要素です。キューの末尾は、特定のプロデューサに関して、もっとも短い時間キューに入っていた要素です。

大半のコレクションとは異なり、size メソッドは一定時間のオペレーションではないことに留意してください。これらのキューには非同期という特性があるため、現在の要素数を判定するには要素全体をトラバースする必要があります。したがって、このコレクションがトラバーサル中に変更された場合、不正確な結果が報告されることがあります。また、addAll、removeAll、retainAll、containsAll、equals、および toArray の一括オペレーションについて、原子的な実行は保証されていません。たとえば、addAll オペレーションと並行して動作するイテレータは、追加された要素の一部しか表示しないことがあります。

このクラスとそのイテレータは、Collection および Iterator インタフェースの任意メソッドすべてを実装します。

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

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

導入されたバージョン:

1.7

関連項目:

直列化された形式

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

コンストラクタ

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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	add(E e) キューの末尾に、指定された要素を挿入します。
boolean	contains(Object o) 指定された要素がキューに含まれている場合に true を返します。
int	drainTo(Collection<? super E> c) このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。
int	drainTo(Collection<? super E> c, int maxElements) 指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。
int	getWaitingConsumerCount() BlockingQueue.take() または時間指定の poll 経由で要素を受け取ることを待機しているコンシューマの推定数を返します。
boolean	hasWaitingConsumer() BlockingQueue.take() または時間指定の poll 経由で要素を受け取ることを待機しているコンシューマが少なくとも 1 つある場合、true を返します。
boolean	isEmpty() キューに要素がない場合に true を返します。
Iterator<E>	iterator() このキュー内の要素を適切な順序で反復処理するイテレータを返します。
boolean	offer(E e) キューの末尾に、指定された要素を挿入します。
boolean	offer(E e, long timeout, TimeUnit unit) キューの末尾に、指定された要素を挿入します。
E	peek() このキューの先頭を取得しますが、削除しません。キューが空の場合は null を返します。
E	poll() このキューの先頭を取得および削除します。キューが空の場合は null を返します。
E	poll(long timeout, TimeUnit unit) このキューの先頭を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。
void	put(E e) キューの末尾に、指定された要素を挿入します。
int	remainingCapacity() LinkedTransferQueue は容量制約を受けないため、常に Integer.MAX_VALUE を返します。
boolean	remove(Object o) 指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
int	size() キュー内にある要素の数を返します。
E	take() このキューの先頭を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。
void	transfer(E e) 待機する必要があれば待機し、要素をコンシューマに転送します。
boolean	tryTransfer(E e) 可能な場合、待機中のコンシューマに要素をただちに転送します。
boolean	tryTransfer(E e, long timeout, TimeUnit unit) タイムアウトが経過する前に要素をコンシューマに転送できる場合には、そうします。

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

addAll, clear, element, remove

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

containsAll, removeAll, retainAll, toArray, toArray, toString

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

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

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

element, remove

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

addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

コンストラクタの詳細

LinkedTransferQueue

public LinkedTransferQueue()

初期状態で空の LinkedTransferQueue を作成します。

LinkedTransferQueue

public LinkedTransferQueue(Collection<? extends E> c)

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

パラメータ:

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

例外:

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

メソッドの詳細

put

public void put(E e)

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

定義:

put、インタフェース: BlockingQueue<E>

パラメータ:

e - 追加する要素

例外:

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

offer

public boolean offer(E e,
            long timeout,
            TimeUnit unit)

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

定義:

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

パラメータ:

e - 追加する要素

timeout - 処理を中止するまでの待機時間。単位は unit

unit - timeout パラメータの解釈方法を決定する TimeUnit

戻り値:

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

例外:

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

offer

public boolean offer(E e)

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

定義:

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

定義:

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

パラメータ:

e - 追加する要素

戻り値:

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

例外:

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

add

public boolean add(E e)

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

定義:

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

定義:

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

定義:

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

オーバーライド:

add、クラス: AbstractQueue<E>

パラメータ:

e - 追加する要素

戻り値:

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

例外:

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

tryTransfer

public boolean tryTransfer(E e)

可能な場合、待機中のコンシューマに要素をただちに転送します。

より正確には、(take() または時間指定の poll で) 要素を受け取ることを待機しているコンシューマがすでに存在する場合は指定された要素をただちに転送し、それ以外の場合は要素をエンキューせずに false を返します。

定義:

tryTransfer、インタフェース: TransferQueue<E>

パラメータ:

e - 転送する要素

戻り値:

true - 要素が転送された場合。それ以外の場合は false

例外:

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

transfer

public void transfer(E e)
              throws InterruptedException

待機する必要があれば待機し、要素をコンシューマに転送します。

より正確には、指定された要素の受信を (take() または時間指定の poll で) すでに待機しているコンシューマが存在する場合はその要素をただちに転送し、それ以外の場合は指定された要素をこのキューの末尾に挿入し、その要素がコンシューマによって受信されるまで待機します。

定義:

transfer、インタフェース: TransferQueue<E>

パラメータ:

e - 転送する要素

例外:

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

InterruptedException - 待機中に割り込まれた場合。この場合、要素はエンキューされたままになりません

tryTransfer

public boolean tryTransfer(E e,
                  long timeout,
                  TimeUnit unit)
                    throws InterruptedException

タイムアウトが経過する前に要素をコンシューマに転送できる場合には、そうします。

より正確には、指定された要素の受信を (take() または時間指定の poll で) すでに待機しているコンシューマが存在する場合はその要素をただちに転送し、それ以外の場合は指定された要素をこのキューの末尾に挿入し、その要素がコンシューマによって受信されるまで待機します。その要素を転送できるようになる前に、指定された待機時間が経過した場合は false を返します。

定義:

tryTransfer、インタフェース: TransferQueue<E>

パラメータ:

e - 転送する要素

timeout - 処理を中止するまでの待機時間。単位は unit

unit - timeout パラメータの解釈方法を決定する TimeUnit

戻り値:

成功した場合は true、完了前に指定された待機時間が経過した場合は false で、この場合、要素はエンキューされたままになりません

例外:

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

InterruptedException - 待機中に割り込まれた場合。この場合、要素はエンキューされたままになりません

take

public E take()
       throws InterruptedException

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

このキューの先頭を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。

定義:

take、インタフェース: BlockingQueue<E>

戻り値:

キューの先頭

例外:

InterruptedException - 待機中に割り込みが発生した場合

poll

public E poll(long timeout,
     TimeUnit unit)
       throws InterruptedException

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

このキューの先頭を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。

定義:

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

パラメータ:

timeout - 処理を中止するまでの待機時間。単位は unit

unit - timeout パラメータの解釈方法を決定する TimeUnit

戻り値:

このキューの先頭。空きが生じる前に指定された待機時間が経過した場合は null

例外:

InterruptedException - 待機中に割り込みが発生した場合

poll

public E poll()

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

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

定義:

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

戻り値:

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

drainTo

public int drainTo(Collection<? super E> c)

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

このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。このオペレーションは、このキューを繰り返しポーリングする場合よりも効率的な場合があります。コレクション c に要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。キューをそれ自体に排出しようとすると、IllegalArgumentException がスローされます。また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

定義:

drainTo、インタフェース: BlockingQueue<E>

パラメータ:

c - 要素の転送先のコレクション

戻り値:

転送された要素の数

例外:

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

IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティーが原因で指定されたコレクションに追加できない場合

drainTo

public int drainTo(Collection<? super E> c,
          int maxElements)

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

指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。コレクション c に要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。キューをそれ自体に排出しようとすると、IllegalArgumentException がスローされます。また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

定義:

drainTo、インタフェース: BlockingQueue<E>

パラメータ:

c - 要素の転送先のコレクション

maxElements - 転送する要素の最大数

戻り値:

転送された要素の数

例外:

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

IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティーが原因で指定されたコレクションに追加できない場合

iterator

public Iterator<E> iterator()

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

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

定義:

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

定義:

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

定義:

iterator、クラス: AbstractCollection<E>

戻り値:

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

peek

public E peek()

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

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

定義:

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

戻り値:

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

isEmpty

public boolean isEmpty()

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

定義:

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

オーバーライド:

isEmpty、クラス: AbstractCollection<E>

戻り値:

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

hasWaitingConsumer

public boolean hasWaitingConsumer()

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

BlockingQueue.take() または時間指定の poll 経由で要素を受け取ることを待機しているコンシューマが少なくとも 1 つある場合、true を返します。戻り値は状況の瞬間的な状態です。

定義:

hasWaitingConsumer、インタフェース: TransferQueue<E>

戻り値:

待機中のコンシューマが少なくとも 1 つ存在する場合は true

size

public int size()

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

大半のコレクションとは異なり、このメソッドは一定時間のオペレーションではないことに留意してください。これらのキューには非同期という特性があるため、現在の要素数を判定するには O(n) トラバーサルが必要です。

定義:

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

定義:

size、クラス: AbstractCollection<E>

戻り値:

キューの要素数

getWaitingConsumerCount

public int getWaitingConsumerCount()

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

BlockingQueue.take() または時間指定の poll 経由で要素を受け取ることを待機しているコンシューマの推定数を返します。戻り値は状況の瞬間的な状態の近似であるため、コンシューマが完了したり、待機を中止したりした場合に不正確になることがあります。この値は監視およびヒューリスティックな方法に役立つ場合がありますが、同期制御のためのものではありません。このメソッドの実装は、TransferQueue.hasWaitingConsumer() の実装よりもかなり遅くなる可能性が高くなります。

定義:

getWaitingConsumerCount、インタフェース: TransferQueue<E>

戻り値:

要素を受け取ることを待機しているコンシューマの数

remove

public boolean remove(Object o)

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

定義:

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

定義:

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

オーバーライド:

remove、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

contains

public boolean contains(Object o)

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

定義:

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

定義:

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

オーバーライド:

contains、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

remainingCapacity

public int remainingCapacity()

LinkedTransferQueue は容量制約を受けないため、常に Integer.MAX_VALUE を返します。

定義:

remainingCapacity、インタフェース: BlockingQueue<E>

戻り値:

Integer.MAX_VALUE (BlockingQueue.remainingCapacity() で指定されているとおり)