LinkedBlockingQueue (Java Platform SE 8)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<E>
  - - java.util.concurrent.LinkedBlockingQueue<E>

型パラメータ:

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

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

Serializable、Iterable<E>、Collection<E>、BlockingQueue<E>、Queue<E>
```
public class LinkedBlockingQueue<E>
extends AbstractQueue<E>
implements BlockingQueue<E>, Serializable
```
リンク・ノードに基づく、オプションで制限付きになるブロッキング・キューです。このキューはFIFO (先入れ先出し)で要素を順序付けします。このキューの先頭は、キューに入っていた時間がもっとも長い要素です。このキューの末尾は、キューに入っていた時間がもっとも短い要素です。新しい要素はキューの末尾に挿入され、キュー取得オペレーションにより、キューの先頭の要素が取得されます。通常、リンクされたキューのスループットは配列ベースのキューよりも高くなりますが、ほとんどの並行処理アプリケーションではパフォーマンスの予測が難しくなります。
任意の容量制限のあるコンストラクタ引数は、過剰なキュー展開を防ぐために機能します。容量は、指定しない場合はInteger.MAX_VALUEと同じです。リンク・ノードは、キューが容量を超えないかぎり挿入のたびに動的に作成されます。
このクラスとそのイテレータは、CollectionおよびIteratorインタフェースの任意メソッドすべてを実装します。
このクラスは、Java Collections Frameworkのメンバーです。

導入されたバージョン:

1.5

関連項目:

直列化された形式

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

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`clear()` すべての要素をこのキューから原子的に削除します。
`boolean`	`contains(Object o)` 指定された要素がキューに含まれている場合に`true`を返します。
`int`	`drainTo(Collection<? super E> c)` このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。
`int`	`drainTo(Collection<? super E> c, int maxElements)` 指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。
`Iterator<E>`	`iterator()` このキュー内の要素を適切な順序で反復処理するイテレータを返します。
`boolean`	`offer(E e)` キューの容量を超えずに指定された要素をこのキューの末尾にすぐ挿入できる場合は、そうします。成功した場合は`true`を返し、キューがいっぱいの場合は`false`を返します。
`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()` 理想的な状態(メモリーやリソースの制限がない状態)で、このキューがブロックせずに受け入れることができる追加要素の数を返します。
`boolean`	`remove(Object o)` 指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
`int`	`size()` キュー内にある要素の数を返します。
`Spliterator<E>`	`spliterator()` このキュー内の要素に対する`Spliterator`を返します。
`E`	`take()` このキューの先頭を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。
`Object[]`	`toArray()` キュー内のすべての要素を適切な順序で含む配列を返します。
`<T> T[]`	`toArray(T[] a)` キュー内のすべての要素を適切な順序で含む配列を返します。返される配列の実行時の型は、指定された配列の型になります。
`String`	`toString()` このコレクションの文字列表現を返します。

クラス java.util.AbstractQueueから継承されたメソッド
add, addAll, element, remove

クラス java.util.AbstractCollectionから継承されたメソッド
containsAll, isEmpty, removeAll, retainAll

クラス java.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

インタフェース java.util.Collectionから継承されたメソッド
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream

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

- コンストラクタの詳細
  - LinkedBlockingQueue
```
public LinkedBlockingQueue()
```
    容量Integer.MAX_VALUEでLinkedBlockingQueueを作成します。
  - LinkedBlockingQueue
```
public LinkedBlockingQueue(int capacity)
```
    指定された固定容量でLinkedBlockingQueueを作成します。
    
    パラメータ:
    
    capacity - このキューの容量
    
    例外:
    
    IllegalArgumentException - capacityが0以下である場合
  - LinkedBlockingQueue
```
public LinkedBlockingQueue(Collection<? extends E> c)
```
    指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加) LinkedBlockingQueueを容量Integer.MAX_VALUEで作成します。
    
    パラメータ:
    
    c - 初期状態で含む要素のコレクション
    
    例外:
    
    NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合
- メソッドの詳細
  - size
```
public int size()
```
    キュー内にある要素の数を返します。
    
    定義:
    
    size、インタフェース: Collection<E>
    
    定義:
    
    size、クラス: AbstractCollection<E>
    
    戻り値:
    
    キューの要素数
  - remainingCapacity
```
public int remainingCapacity()
```
    理想的な状態(メモリーやリソースの制限がない状態)で、このキューがブロックせずに受け入れることができる追加要素の数を返します。このキューの初期容量から現在のsizeを引いた値と常に同じです。
    remainingCapacityを調べても要素の挿入試行が成功するかどうかがわかるとはかぎりません。これは別のスレッドが要素を挿入または削除しようとしている可能性があるためです。
    
    定義:
    
    remainingCapacity、インタフェース: BlockingQueue<E>
    
    戻り値:
    
    残りの容量
  - put
```
public void put(E e)
         throws InterruptedException
```
    指定された要素をこのキューの末尾に挿入します。必要に応じて、空きが生じるまで待機します。
    
    定義:
    
    put、インタフェース: BlockingQueue<E>
    
    パラメータ:
    
    e - 追加する要素
    
    例外:
    
    InterruptedException - 待機中に割込みが発生した場合
    
    NullPointerException - 指定された要素がnullである場合
  - offer
```
public boolean offer(E e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException
```
    指定された要素をこのキューの末尾に挿入します。必要に応じて、指定された待機時間まで空きが生じるのを待機します。
    
    定義:
    
    offer、インタフェース: BlockingQueue<E>
    
    パラメータ:
    
    e - 追加する要素
    
    timeout - 処理を中止するまでの待機時間。単位はunit
    
    unit - timeoutパラメータの解釈方法を決定するTimeUnit
    
    戻り値:
    
    成功した場合はtrue、空きが生じる前に指定された待機時間が経過した場合はfalse
    
    例外:
    
    InterruptedException - 待機中に割込みが発生した場合
    
    NullPointerException - 指定された要素がnullである場合
  - offer
```
public boolean offer(E e)
```
    キューの容量を超えずに指定された要素をこのキューの末尾にすぐ挿入できる場合は、そうします。成功した場合はtrueを返し、キューがいっぱいの場合はfalseを返します。容量制限のあるキューを使用する場合、通常は、要素の挿入に失敗した場合に例外をスローするのみのaddメソッドよりも、このメソッドを使用することをお薦めします。
    
    定義:
    
    offer、インタフェース: BlockingQueue<E>
    
    定義:
    
    offer、インタフェース: Queue<E>
    
    パラメータ:
    
    e - 追加する要素
    
    戻り値:
    
    このキューに要素が追加された場合はtrue、それ以外の場合はfalse
    
    例外:
    
    NullPointerException - 指定された要素がnullである場合
  - 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
  - peek
```
public E peek()
```
    インタフェースからコピーされた説明: Queue
    
    このキューの先頭を取得しますが、削除しません。キューが空の場合はnullを返します。
    
    定義:
    
    peek、インタフェース: Queue<E>
    
    戻り値:
    
    このキューの先頭。キューが空の場合はnull
  - 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
  - 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である場合
  - toString
```
public String toString()
```
    次のクラスからコピーされた説明: AbstractCollection
    
    このコレクションの文字列表現を返します。文字列表現は、コレクションの要素をそのイテレータが返した順に角括弧("[]")で囲んで示すリストです。隣接する要素は、文字", " (カンマと空白文字)によって区切られます。要素は、String.valueOf(Object)により文字列に変換されます。
    
    オーバーライド:
    
    toString、クラス: AbstractCollection<E>
    
    戻り値:
    
    このコレクションの文字列表現
  - clear
```
public void clear()
```
    すべての要素をこのキューから原子的に削除します。この呼出しが戻ると、キューは空になります。
    
    定義:
    
    clear、インタフェース: Collection<E>
    
    オーバーライド:
    
    clear、クラス: AbstractQueue<E>
  - drainTo
```
public int drainTo(Collection<? super E> c)
```
    インタフェースからコピーされた説明: BlockingQueue
    
    このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。このオペレーションは、このキューを繰返しポーリングする場合よりも効率的な場合があります。コレクションcに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。
    
    定義:
    
    drainTo、インタフェース: BlockingQueue<E>
    
    パラメータ:
    
    c - 要素の転送先のコレクション
    
    戻り値:
    
    転送された要素の数
    
    例外:
    
    UnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合
    
    ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合
    
    NullPointerException - 指定されたコレクションがnullである場合
    
    IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合
  - drainTo
```
public int drainTo(Collection<? super E> c,
                   int maxElements)
```
    インタフェースからコピーされた説明: BlockingQueue
    
    指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。コレクションcに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。
    
    定義:
    
    drainTo、インタフェース: BlockingQueue<E>
    
    パラメータ:
    
    c - 要素の転送先のコレクション
    
    maxElements - 転送する要素の最大数
    
    戻り値:
    
    転送された要素の数
    
    例外:
    
    UnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合
    
    ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合
    
    NullPointerException - 指定されたコレクションがnullである場合
    
    IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合
  - iterator
```
public Iterator<E> iterator()
```
    このキュー内の要素を適切な順序で反復処理するイテレータを返します。要素は最初(先頭)から最後(末尾)の順に返されます。
    返されるイテレータは弱一貫性を保持します。
    
    定義:
    
    iterator、インタフェース: Iterable<E>
    
    定義:
    
    iterator、インタフェース: Collection<E>
    
    定義:
    
    iterator、クラス: AbstractCollection<E>
    
    戻り値:
    
    キュー内の要素を適切な順序で繰返し処理するイテレータ
  - spliterator
```
public Spliterator<E> spliterator()
```
    このキュー内の要素に対するSpliteratorを返します。
    返されるスプリッテレータは弱一貫性を保持します。
    Spliteratorは、Spliterator.CONCURRENT、Spliterator.ORDEREDおよびSpliterator.NONNULLを報告します。
    
    定義:
    
    spliterator、インタフェース: Iterable<E>
    
    定義:
    
    spliterator、インタフェース: Collection<E>
    
    実装上の注意:
    
    Spliteratorは、制限付きの並列処理を許可するためにtrySplitを実装します。
    
    戻り値:
    
    このキュー内の要素に対するSpliterator
    
    導入されたバージョン:
    
    1.8

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスLinkedBlockingQueue<E>

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

メソッドのサマリー

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

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

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

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

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

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

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

コンストラクタの詳細

LinkedBlockingQueue

LinkedBlockingQueue

LinkedBlockingQueue

メソッドの詳細

size

remainingCapacity

put

offer

offer

take

poll

poll

peek

remove

contains

toArray

toArray

toString

clear

drainTo

drainTo

iterator

spliterator