- 型パラメータ:
E
- このキューに保持されている要素の型
- すべての実装されたインタフェース:
Serializable
,Iterable<E>
,Collection<E>
,BlockingQueue<E>
,Queue<E>
PriorityQueue
と同じ順序付けルールを使用するとともにブロッキング取得オペレーションを提供する、制限なしのブロッキング・キューです。 このキューは論理的にはアンバウンド形式ですが、追加を試みてもリソース不足によりOutOfMemoryError
が発生して失敗することがあります。 このクラスは、null
要素を許容しません。 自然順序付けに基づく優先度キューでは、比較不可能なオブジェクトの挿入も許可されません(実行するとClassCastException
がスローされることがある)。
このクラスとそのイテレータは、Collection
およびIterator
インタフェースのオプション・メソッドすべてを実装します。 メソッドiterator()
で提供されているイテレータおよびメソッドspliterator()
で提供されているスプリッタは、特定の順序でPriorityBlockingQueueの要素をトラバースすることは保証されません。 要素をトラバースする順序を指定する必要がある場合は、Arrays.sort(pq.toArray())
の使用を考慮してください。 また、drainTo
メソッドを使用して、優先順位順に一部またはすべての要素を削除して、それらを別のコレクションに配置することもできます。
このクラスのオペレーションでは、優先順位が同じ要素の順序付けについて保証がありません。 順序付けを適用する必要がある場合は、カスタムのクラスまたはコンパレータを定義して、第1の優先順位値が同じ場合に順序付けするために第2のキーを使用することができます。 たとえば次のクラスでは、比較可能な要素に対して要素の優先順位が同じ場合は、先入れ先出し方式の順序付けを適用します。 このクラスを使用するには、通常のエントリ・オブジェクトの代わりにnew FIFOEntry(anEntry)
を挿入します。
class FIFOEntry<E extends Comparable<? super E>>
implements Comparable<FIFOEntry<E>> {
static final AtomicLong seq = new AtomicLong();
final long seqNum;
final E entry;
public FIFOEntry(E entry) {
seqNum = seq.getAndIncrement();
this.entry = entry;
}
public E getEntry() { return entry; }
public int compareTo(FIFOEntry<E> other) {
int res = entry.compareTo(other.entry);
if (res == 0 && other.entry != this.entry)
res = (seqNum < other.seqNum ? -1 : 1);
return res;
}
}
このクラスは、Java Collections Frameworkのメンバーです。
- 導入されたバージョン:
- 1.5
- 関連項目:
-
コンストラクタのサマリー
コンストラクタ説明自然順序付けに従って要素を順序付けする、デフォルトの初期容量(11)を持つPriorityBlockingQueue
を作成します。PriorityBlockingQueue
(int initialCapacity) 自然順序付けに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueue
を作成します。PriorityBlockingQueue
(int initialCapacity, Comparator<? super E> comparator) 指定されたコンパレータに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueue
を作成します。PriorityBlockingQueue
(Collection<? extends E> c) 指定されたコレクション内の要素を含むPriorityBlockingQueue
を作成します。 -
メソッドのサマリー
修飾子と型メソッド説明boolean
指定された要素をこの優先度キューに挿入します。void
clear()
すべての要素をこのキューから原子的に削除します。Comparator
<? super E> このキュー内の要素を順序付けするのに使うコンパレータを返します。ただし、このキューがその要素の自然順序付けを使う場合はnull
を返します。boolean
指定された要素がキューに含まれている場合にtrue
を返します。int
drainTo
(Collection<? super E> c) このキューから利用可能なすべての要素を削除し、それらを指定されたコレクションに追加します。int
drainTo
(Collection<? super E> c, int maxElements) 指定された数以内の利用可能な要素をこのキューから削除し、指定されたコレクションに追加します。void
Iterable
の各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。iterator()
このキュー内の要素のイテレータを返します。boolean
指定された要素をこの優先度キューに挿入します。boolean
指定された要素をこの優先度キューに挿入します。peek()
キューの先頭を取得しますが、削除しません。キューが空の場合はnull
を返します。poll()
キューの先頭を取得および削除します。キューが空の場合はnull
を返します。このキューの先頭を取得して削除します。必要に応じて、指定された待機時間まで要素が利用可能になるのを待機します。void
指定された要素をこの優先度キューに挿入します。int
PriorityBlockingQueue
は容量制約を受けないため、常にInteger.MAX_VALUE
を返します。boolean
指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。boolean
removeAll
(Collection<?> c) 指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。boolean
指定された述語(オプションの操作)を満たす、このコレクションのすべての要素を削除します。boolean
retainAll
(Collection<?> c) このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。int
size()
このコレクション中の要素の数を返します。このキュー内の要素に対するSpliterator
を返します。take()
このキューの先頭を取得して削除します。必要に応じて、要素が利用可能になるまで待機します。Object[]
toArray()
このキューの要素がすべて含まれている配列を返します。<T> T[]
toArray
(T[] a) このキュー内のすべての要素を含む配列を返します。返される配列の実行時の型は、指定された配列の型です。クラスjava.util.AbstractQueueで宣言されたメソッド
addAll, element, remove
クラスjava.util.AbstractCollectionで宣言されたメソッド
containsAll, isEmpty, toString
クラスjava.lang.Objectで宣言されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
インタフェースjava.util.Collectionで宣言されたメソッド
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray
-
コンストラクタの詳細
-
PriorityBlockingQueue
public PriorityBlockingQueue()自然順序付けに従って要素を順序付けする、デフォルトの初期容量(11)を持つPriorityBlockingQueue
を作成します。 -
PriorityBlockingQueue
public PriorityBlockingQueue(int initialCapacity) 自然順序付けに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueue
を作成します。- パラメータ:
initialCapacity
- この優先度キューの初期容量- 例外:
IllegalArgumentException
-initialCapacity
が1より小さい場合
-
PriorityBlockingQueue
public PriorityBlockingQueue(int initialCapacity, Comparator<? super E> comparator) 指定されたコンパレータに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueue
を作成します。- パラメータ:
initialCapacity
- この優先度キューの初期容量comparator
- この優先度キューを順序付けするために使用されるコンパレータ。null
の場合、要素の自然順序付けが使用される。- 例外:
IllegalArgumentException
-initialCapacity
が1より小さい場合
-
PriorityBlockingQueue
public PriorityBlockingQueue(Collection<? extends E> c) 指定されたコレクション内の要素を含むPriorityBlockingQueue
を作成します。 指定されたコレクションがSortedSet
またはPriorityBlockingQueue
の場合、この優先度キューは同じ順序に従って順序付けされます。 それ以外の場合、この優先度キューの順序付けは、その要素の自然順序付けに従って行われます。- パラメータ:
c
- 要素がこの優先度キューに配置されるコレクション- 例外:
ClassCastException
- 指定されたコレクションの要素を優先度キューの順序付けに従って相互比較できない場合NullPointerException
- 指定されたコレクションまたはそのいずれかの要素がnullである場合
-
-
メソッドの詳細
-
add
public boolean add(E e) 指定された要素をこの優先度キューに挿入します。- 定義:
add
、インタフェースBlockingQueue<E>
- 定義:
add
、インタフェースCollection<E>
- 定義:
add
、インタフェースQueue<E>
- オーバーライド:
add
、クラスAbstractQueue<E>
- パラメータ:
e
- 追加する要素- 戻り値:
true
(Collection.add(E)
で指定されているとおり)- 例外:
ClassCastException
- 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合NullPointerException
- 指定された要素がnullである場合
-
offer
public boolean offer(E e) 指定された要素をこの優先度キューに挿入します。 キューがアンバウンド形式であるため、このメソッドはfalse
を返しません。- 定義:
offer
、インタフェースBlockingQueue<E>
- 定義:
offer
、インタフェースQueue<E>
- パラメータ:
e
- 追加する要素- 戻り値:
true
(Queue.offer(E)
で指定されているとおり)- 例外:
ClassCastException
- 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合NullPointerException
- 指定された要素がnullである場合
-
put
public void put(E e) 指定された要素をこの優先度キューに挿入します。 キューがアンバウンド形式であるため、このメソッドはブロックを実行しません。- 定義:
put
、インタフェースBlockingQueue<E>
- パラメータ:
e
- 追加する要素- 例外:
ClassCastException
- 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合NullPointerException
- 指定された要素がnullである場合
-
offer
指定された要素をこの優先度キューに挿入します。 キューがアンバウンド形式であるため、このメソッドはブロックを実行しないか、false
を返しません。- 定義:
offer
、インタフェースBlockingQueue<E>
- パラメータ:
e
- 追加する要素timeout
- メソッドがブロックを実行することはないため、このパラメータは無視されるunit
- メソッドがブロックを実行することはないため、このパラメータは無視される- 戻り値:
true
(BlockingQueue.offer
で指定されているとおり)- 例外:
ClassCastException
- 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合NullPointerException
- 指定された要素がnullである場合
-
poll
-
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
- 待機中に割込みが発生した場合
-
peek
-
comparator
public Comparator<? super E> comparator()このキュー内の要素を順序付けするのに使うコンパレータを返します。ただし、このキューがその要素の自然順序付けを使う場合はnull
を返します。- 戻り値:
- このキュー内の要素を順序付けするのに使うコンパレータ。このキューがその要素の自然順序付けを使用する場合は
null
-
size
public int size()次のインタフェースからコピーされた説明:Collection
このコレクション中の要素の数を返します。 このコレクションに複数のInteger.MAX_VALUE
要素が含まれている場合は、Integer.MAX_VALUE
を返します。- 定義:
size
、インタフェースCollection<E>
- 戻り値:
- このコレクションの要素数
-
remainingCapacity
public int remainingCapacity()PriorityBlockingQueue
は容量制約を受けないため、常にInteger.MAX_VALUE
を返します。- 定義:
remainingCapacity
、インタフェースBlockingQueue<E>
- 戻り値:
Integer.MAX_VALUE
(常時)
-
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
-
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
- 指定されたコレクションがこのキューである場合、またはこのキューの要素のあるプロパティが原因で指定されたコレクションに追加できない場合
-
clear
public void clear()すべての要素をこのキューから原子的に削除します。 この呼出しが戻ると、キューは空になります。- 定義:
clear
、インタフェースCollection<E>
- オーバーライド:
clear
、クラスAbstractQueue<E>
-
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である場合
-
iterator
-
spliterator
public Spliterator<E> spliterator()このキュー内の要素に対するSpliterator
を返します。 spliteratorは、特定の順序で要素をトラバースしません(ORDERED
特性は報告されません)。返されるスプリッテレータは弱一貫性を保持します。
Spliterator
は、Spliterator.SIZED
およびSpliterator.NONNULL
を報告します。- 定義:
spliterator
、インタフェースCollection<E>
- 定義:
spliterator
、インタフェースIterable<E>
- 実装上のノート:
Spliterator
は、さらにSpliterator.SUBSIZED
を報告します。- 戻り値:
- このキュー内の要素に対する
Spliterator
- 導入されたバージョン:
- 1.8
-
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要素(optional)をサポートしていない場合、または指定されたコレクションがnullの場合- 関連項目:
-
retainAll
public boolean retainAll(Collection<?> c) 次のクラスからコピーされた説明:AbstractCollection
このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。 つまり、指定されたコレクションに格納されていないすべての要素をこのコレクションから削除します。- 定義:
retainAll
、インタフェースCollection<E>
- オーバーライド:
retainAll
、クラスAbstractCollection<E>
- パラメータ:
c
- このコレクションで保持される要素を含むコレクション- 戻り値:
- コールの結果としてこのコレクションが変更された場合、
true
- 例外:
NullPointerException
- このコレクションに1つ以上のnull要素が含まれ、指定したコレクションでnull要素(optional)が許可されていない場合、または指定されたコレクションがnullの場合- 関連項目:
-
forEach
インタフェースからコピーされた説明:Iterable
Iterable
の各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。このメソッドの動作は、オーバーライドするクラスが同時変更ポリシーを指定していないかぎり、要素の基礎となるソースを変更する副作用をアクションが実行する場合には指定されません。
- 定義:
forEach
、インタフェースIterable<E>
- パラメータ:
action
- 各要素に対して実行されるアクション- 例外:
NullPointerException
- 指定されたアクションがnullである場合
-