- 型パラメータ:
E
- このキューに保持されている要素の型
- すべての実装されたインタフェース:
Serializable
,Iterable<E>
,Collection<E>
,BlockingQueue<E>
,Queue<E>
public class ArrayBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
これは旧来のバウンド・バッファであり、その内部では固定サイズの配列が要素を保持し、これらの要素はプロデューサにより挿入され、コンシューマにより抽出されます。 作成後に、容量を変更することはできません。 キューが埋まっているときに要素をput
しようとすると、putオペレーションがブロックされます。空のキューから要素をput
しようとした場合も、同様にブロックされます。
このクラスでは、待機中のプロデューサおよびコンシューマ・スレッドの順序付けのためのオプションの公平性ポリシーをサポートします。 デフォルトでは、この順序付けは保証されていません。 ただし、公平性をtrue
に設定して構築されたキューでは、スレッドがFIFOの順序でアクセスすることが許可されます。 通常は、公平性によりスループットが低下しますが、変動性も低下するため、枯渇状態になることはありません。
このクラスとそのイテレータは、Collection
およびIterator
インタフェースのオプション・メソッドすべてを実装します。
このクラスは、Java Collections Frameworkのメンバーです。
- 導入されたバージョン:
- 1.5
- 関連項目:
- 直列化された形式
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 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)
指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。void
forEach(Consumer<? super E> action)
Iterable
の各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。Iterator<E>
iterator()
このキュー内の要素を適切な順序で反復処理するイテレータを返します。boolean
offer(E e)
キューの容量を超えずに指定された要素をこのキューの末尾にすぐ挿入できる場合は、そうします。成功した場合はtrue
を返し、キューがいっぱいの場合はfalse
を返します。boolean
offer(E e, long timeout, TimeUnit unit)
指定された要素をこのキューの末尾に挿入します。このキューがいっぱいである場合は、指定された時間まで空きが生じるのを待機します。void
put(E e)
指定された要素をこのキューの末尾に挿入します。このキューがいっぱいの場合は、空きが生じるまで待機します。int
remainingCapacity()
理想的な状態(メモリーやリソースの制限がない状態)で、このキューがブロックせずに受け入れることができる追加要素の数を返します。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.lang.Objectで宣言されたメソッド
clone、equals、finalize、getClass、hashCode、notify、notifyAll、wait、wait、wait
インタフェース java.util.Collectionで宣言されたメソッド
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray
-
コンストラクタの詳細
-
ArrayBlockingQueue
public ArrayBlockingQueue(int capacity)指定された(固定)容量とデフォルトのアクセス・ポリシーを持つArrayBlockingQueue
を作成します。- パラメータ:
capacity
- このキューの容量- 例外:
IllegalArgumentException
-capacity < 1
の場合
-
ArrayBlockingQueue
public ArrayBlockingQueue(int capacity, boolean fair)指定された(固定)容量と指定されたアクセス・ポリシーを持つArrayBlockingQueue
を作成します。- パラメータ:
capacity
- このキューの容量fair
-true
の場合、挿入または削除でブロックされたスレッドに対するキュー・アクセスがFIFOの順序で処理される。false
の場合、アクセス順は指定されない。- 例外:
IllegalArgumentException
-capacity < 1
の場合
-
ArrayBlockingQueue
public ArrayBlockingQueue(int capacity, boolean fair, Collection<? extends E> c)指定された(固定)容量と指定されたアクセス・ポリシーを持ち、指定されたコレクションの要素を初期状態で含む(要素はコレクションのイテレータのトラバーサル順に追加)ArrayBlockingQueue
を作成します。- パラメータ:
capacity
- このキューの容量fair
-true
の場合、挿入または削除でブロックされたスレッドに対するキュー・アクセスがFIFOの順序で処理される。false
の場合、アクセス順は指定されない。c
- 初期状態で含む要素のコレクション- 例外:
IllegalArgumentException
-capacity
がc.size()
より小さいか、または1より小さい場合。NullPointerException
- 指定されたコレクションまたはそのいずれかの要素がnullである場合
-
-
メソッドの詳細
-
add
public boolean add(E e)キューの容量を超えずにすぐ実行できる場合は、指定された要素をこのキューの末尾に挿入します。成功した場合はtrue
を返し、キューがいっぱいの場合はIllegalStateException
をスローします。- 定義:
add
、インタフェース:BlockingQueue<E>
- 定義:
add
、インタフェース:Collection<E>
- 定義:
add
、インタフェース:Queue<E>
- オーバーライド:
add
、クラス:AbstractQueue<E>
- パラメータ:
e
- 追加する要素- 戻り値:
true
(Collection.add(E)
で指定されているとおり)- 例外:
IllegalStateException
- このキューがいっぱいの場合NullPointerException
- 指定された要素がnullである場合
-
offer
public boolean offer(E e)キューの容量を超えずに指定された要素をこのキューの末尾にすぐ挿入できる場合は、そうします。成功した場合はtrue
を返し、キューがいっぱいの場合はfalse
を返します。 通常は、要素の挿入に失敗した場合に例外をスローするのみのadd(E)
メソッドよりもこのメソッドを使用することをお薦めします。- 定義:
offer
、インタフェース:BlockingQueue<E>
- 定義:
offer
、インタフェース:Queue<E>
- パラメータ:
e
- 追加する要素- 戻り値:
- このキューに要素が追加された場合は
true
、それ以外の場合はfalse
- 例外:
NullPointerException
- 指定された要素がnullである場合
-
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である場合
-
size
public int size()キュー内にある要素の数を返します。- 定義:
size
、インタフェース:Collection<E>
- 戻り値:
- キューの要素数
-
remainingCapacity
public int remainingCapacity()理想的な状態(メモリーやリソースの制限がない状態)で、このキューがブロックせずに受け入れることができる追加要素の数を返します。 このキューの初期容量から現在のsize
を引いた値と常に同じです。remainingCapacity
を調べても要素の挿入試行が成功するかどうかがわかるとはかぎりません。これは別のスレッドが要素を挿入または削除しようとしている可能性があるためです。- 定義:
remainingCapacity
、インタフェース:BlockingQueue<E>
- 戻り値:
- 残りの容量
-
remove
public boolean remove(Object o)指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。 つまり、キュー内に、o.equals(e)
に該当する要素e
が1つ以上含まれている場合は、そのような要素を削除します。 指定された要素がこのキューに含まれていた場合、つまり、呼出しの結果としてこのキューが変更された場合にtrue
を返します。巡回配列ベースのキューにある内部要素の削除は本質的に遅く、しかも破壊的な操作であるため、例外的な状況でのみ、理想的には、ほかのスレッドからそのキューにアクセスできないことがわかっている場合にのみ実行するようにしてください。
- 定義:
remove
、インタフェース:BlockingQueue<E>
- 定義:
remove
、インタフェース:Collection<E>
- オーバーライド:
remove
、クラス:AbstractCollection<E>
- パラメータ:
o
- キューから削除される要素(その要素が存在する場合)- 戻り値:
- この呼出しの結果、このキューが変更された場合は
true
-
contains
public boolean contains(Object o)指定された要素がキューに含まれている場合にtrue
を返します。 つまり、このキュー内にo.equals(e)
のような1つ以上の要素e
が含まれている場合、true
を返します。- 定義:
contains
、インタフェース:BlockingQueue<E>
- 定義:
contains
、インタフェース:Collection<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である場合
-
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
- 定義:
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
-
forEach
インタフェースからコピーされた説明:Iterable
Iterable
の各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。オーバーライドするクラスが並行変更ポリシーを指定していない限り、アクションが要素の基本ソースを変更する副作用を実行する場合、このメソッドの動作は指定されていません。
- 定義:
forEach
、インタフェース:Iterable<E>
- パラメータ:
action
- 各要素に対して実行されるアクション- 例外:
NullPointerException
- 指定されたアクションがnullである場合
-
removeIf
次のインタフェースからコピーされた説明: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要素をサポートしない場合(オプション)、または指定されたコレクションが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要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合- 関連項目:
AbstractCollection.remove(Object)
,AbstractCollection.contains(Object)
-