E - このコレクション内に保持される要素の型public class ArrayBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
これは旧来のバウンド・バッファであり、その内部では固定サイズの配列が要素を保持し、これらの要素はプロデューサにより挿入され、コンシューマにより抽出されます。 作成後に、容量を変更することはできません。 キューが埋まっているときに要素をputしようとすると、putオペレーションがブロックされます。空のキューから要素をputしようとした場合も、同様にブロックされます。
このクラスでは、待機中のプロデューサおよびコンシューマ・スレッドの順序付けのためのオプションの公平性ポリシーをサポートします。 デフォルトでは、この順序付けは保証されていません。 ただし、公平性をtrueに設定して構築されたキューでは、スレッドがFIFOの順序でアクセスすることが許可されます。 通常は、公平性によりスループットが低下しますが、変動性も低下するため、枯渇状態になることはありません。
このクラスとそのイテレータは、CollectionおよびIteratorインタフェースの任意メソッドすべてを実装します。
このクラスは、Java Collections Frameworkのメンバーです。
| コンストラクタ | 説明 |
|---|---|
ArrayBlockingQueue(int capacity) |
指定された(固定)容量とデフォルトのアクセス・ポリシーを持つ
ArrayBlockingQueueを作成します。 |
ArrayBlockingQueue(int capacity, boolean fair) |
指定された(固定)容量と指定されたアクセス・ポリシーを持つ
ArrayBlockingQueueを作成します。 |
ArrayBlockingQueue(int capacity, boolean fair, Collection<? extends E> c) |
指定された(固定)容量と指定されたアクセス・ポリシーを持ち、指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加)
ArrayBlockingQueueを作成します。 |
| 修飾子と型 | メソッド | 説明 |
|---|---|---|
boolean |
add(E e) |
キューの容量を超えずにすぐ実行できる場合は、指定された要素をこのキューの末尾に挿入します。成功した場合は
trueを返し、キューがいっぱいの場合はIllegalStateExceptionをスローします。 |
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() |
このコレクションの文字列表現を返します。
|
addAll, element, removecontainsAll, isEmpty, removeAll, retainAllclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddAll, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, streampublic ArrayBlockingQueue(int capacity)
ArrayBlockingQueueを作成します。capacity - このキューの容量IllegalArgumentException - capacity < 1の場合public ArrayBlockingQueue(int capacity,
boolean fair)
ArrayBlockingQueueを作成します。capacity - このキューの容量fair - trueの場合、挿入または削除でブロックされたスレッドに対するキュー・アクセスがFIFOの順序で処理される。falseの場合、アクセス順は指定されない。IllegalArgumentException - capacity < 1の場合public ArrayBlockingQueue(int capacity,
boolean fair,
Collection<? extends E> c)
ArrayBlockingQueueを作成します。capacity - このキューの容量fair - trueの場合、挿入または削除でブロックされたスレッドに対するキュー・アクセスがFIFOの順序で処理される。falseの場合、アクセス順は指定されない。c - 初期状態で含む要素のコレクションIllegalArgumentException - capacityがc.size()より小さいか、または1より小さい場合。NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合public boolean add(E e)
trueを返し、キューがいっぱいの場合はIllegalStateExceptionをスローします。add、インタフェースCollection<E>add、インタフェースBlockingQueue<E>add、インタフェースQueue<E>add、クラスAbstractQueue<E>e - 追加する要素true (Collection.add(E)で指定されているとおり)IllegalStateException - このキューがいっぱいの場合NullPointerException - 指定された要素がnullである場合public boolean offer(E e)
trueを返し、キューがいっぱいの場合はfalseを返します。 通常は、要素の挿入に失敗した場合に例外をスローするのみのadd(E)メソッドよりもこのメソッドを使用することをお薦めします。 offer、インタフェースBlockingQueue<E>offer、インタフェースQueue<E>e - 追加する要素true、それ以外の場合はfalseNullPointerException - 指定された要素がnullである場合public void put(E e) throws InterruptedException
put、インタフェースBlockingQueue<E>e - 追加する要素InterruptedException - 待機中に割込みが発生した場合NullPointerException - 指定された要素がnullである場合public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException
offer、インタフェースBlockingQueue<E>e - 追加する要素timeout - 処理を中止するまでの待機時間。単位はunitunit - timeoutパラメータの解釈方法を決定するTimeUnittrue、空きが生じる前に指定された待機時間が経過した場合はfalseInterruptedException - 待機中に割込みが発生した場合NullPointerException - 指定された要素がnullである場合public E take() throws InterruptedException
BlockingQueuetake、インタフェースBlockingQueue<E>InterruptedException - 待機中に割込みが発生した場合public E poll(long timeout, TimeUnit unit) throws InterruptedException
BlockingQueuepoll、インタフェースBlockingQueue<E>timeout - 処理を中止するまでの待機時間。単位はunitunit - timeoutパラメータの解釈方法を決定するTimeUnitnullInterruptedException - 待機中に割込みが発生した場合public int size()
size、インタフェースCollection<E>size、クラスAbstractCollection<E>public int remainingCapacity()
sizeを引いた値と常に同じです。
remainingCapacityを調べても要素の挿入試行が成功するかどうかがわかるとはかぎりません。これは別のスレッドが要素を挿入または削除しようとしている可能性があるためです。
remainingCapacity、インタフェースBlockingQueue<E>public boolean remove(Object o)
o.equals(e)に該当する要素eが1つ以上含まれている場合は、そのような要素を削除します。 指定された要素がこのキューに含まれていた場合、つまり、呼出しの結果としてこのキューが変更された場合にtrueを返します。
巡回配列ベースのキューにある内部要素の削除は本質的に遅く、しかも破壊的な操作であるため、例外的な状況でのみ、理想的には、ほかのスレッドからそのキューにアクセスできないことがわかっている場合にのみ実行するようにしてください。
remove、インタフェースCollection<E>remove、インタフェースBlockingQueue<E>remove、クラスAbstractCollection<E>o - キューから削除される要素(その要素が存在する場合)truepublic boolean contains(Object o)
trueを返します。 つまり、このキュー内にo.equals(e)のような1つ以上の要素eが含まれている場合、trueを返します。 contains、インタフェースCollection<E>contains、インタフェースBlockingQueue<E>contains、クラスAbstractCollection<E>o - このキューに含まれているかどうかを調べるオブジェクトtruepublic Object[] toArray()
返される配列は、それへの参照がこのキューで保持されない場合に、安全になります。 (つまり、このメソッドは新しい配列を割り当てます)。 このため、呼出し側は、返された配列を自由に変更できます。
このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。
toArray、インタフェースCollection<E>toArray、クラスAbstractCollection<E>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である場合public String toString()
AbstractCollectionString.valueOf(Object)により文字列に変換されます。 toString、クラスAbstractCollection<E>public void clear()
clear、インタフェースCollection<E>clear、クラスAbstractQueue<E>public int drainTo(Collection<? super E> c)
BlockingQueuecに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。 キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。 また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。 drainTo、インタフェースBlockingQueue<E>c - 要素の転送先のコレクションUnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合NullPointerException - 指定されたコレクションがnullである場合IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合public int drainTo(Collection<? super E> c, int maxElements)
BlockingQueuecに要素を追加しようとしたときに障害が発生すると、関連する例外のスロー時に、要素がこのキューとコレクションのいずれにも存在しない場合と、一方または両方に存在する場合があります。 キューをそれ自体に排出しようとすると、IllegalArgumentExceptionがスローされます。 また、オペレーションの進行中に指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。 drainTo、インタフェースBlockingQueue<E>c - 要素の転送先のコレクションmaxElements - 転送する要素の最大数UnsupportedOperationException - 指定されたコレクションで追加の要素がサポートされていない場合ClassCastException - このキューの要素のクラスが原因で、その要素を指定されたコレクションに追加できない場合NullPointerException - 指定されたコレクションがnullである場合IllegalArgumentException - 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合public Iterator<E> iterator()
iterator、インタフェースIterable<E>iterator、インタフェースCollection<E>iterator、クラスAbstractCollection<E>public Spliterator<E> spliterator()
Spliteratorを返します。
返されるスプリッテレータは弱一貫性を保持します。
Spliteratorは、Spliterator.CONCURRENT、Spliterator.ORDEREDおよびSpliterator.NONNULLを報告します。
spliterator、インタフェースIterable<E>spliterator、インタフェースCollection<E>Spliteratorは、制限付きの並列処理を許可するためにtrySplitを実装します。Spliterator バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。 そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Documentation Redistribution Policyも参照してください。