java.util.concurrent
クラス PriorityBlockingQueue<E>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractQueue<E>
          java.util.concurrent.PriorityBlockingQueue<E>

型パラメータ:

E - コレクション内に存在する要素の型

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

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

public class PriorityBlockingQueue<E>
extends AbstractQueue<E>
implements BlockingQueue<E>, Serializable

PriorityQueue クラスと同じ順序付け規則を使用し、ブロック取得操作を提供する、アンバウンド形式のブロックキュー。このキューは、論理的にアンバウンド形式ですが、リソースの枯渇のために追加が失敗する場合があります (OutOfMemoryError が引き起こされる)。このクラスは、null 要素を許可しません。自然順序付けに依存する優先度キューも、非互換オブジェクトの挿入を許可しません (実行すると ClassCastException がスローされる)。

このクラスとその反復子は、Collection および Iterator インタフェースの「オプション」メソッドすべてを実装します。iterator() メソッド内で提供される Iterator では、特定の順序で PriorityBlockingQueue の要素をたどることは保証されません。要素をたどる順序を指定する必要がある場合は、Arrays.sort(pq.toArray()) の使用を考慮してください。

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

導入されたバージョン:

1.5

関連項目:

直列化された形式

コンストラクタの概要

PriorityBlockingQueue()
自然順序付けに従って要素を順序付けする (Comparable を使用)、デフォルトの初期容量 (11) を持つ PriorityBlockingQueue を作成します。

PriorityBlockingQueue(Collection<? extends E> c)
指定されたコレクション内の要素を含む PriorityBlockingQueue を作成します。

PriorityBlockingQueue(int initialCapacity)
自然順序付けに従って要素を順序付けする (Comparable を使用)、指定された初期容量を持つ PriorityBlockingQueue を作成します。

PriorityBlockingQueue(int initialCapacity, Comparator<? super E> comparator)
指定されたコンパレータに従って要素を順序付けする、指定された初期容量を持つ PriorityBlockingQueue を作成します。

メソッドの概要

boolean	add(E o) 指定された要素をこのキューに追加します。
void	clear() キューからすべての要素を原子的に削除します。
Comparator<? super E>	comparator() コレクションの順序付けに使うコンパレータを返します。
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 o) 指定された要素をこの優先度キューに挿入します。
boolean	offer(E o, long timeout, TimeUnit unit) 指定された要素をこの優先度キューに挿入します。
E	peek() キューの先頭を取得しますが、削除しません。
E	poll() キューの先頭を取得および削除します。
E	poll(long timeout, TimeUnit unit) このキューの先頭を取得および削除します。
void	put(E o) 指定された要素をこの優先度キューに追加します。
int	remainingCapacity() PriorityBlockingQueue は容量制限がないため、常に Integer.MAX_VALUE を返します。
boolean	remove(Object o) 指定された要素の単一のインスタンスがある場合は、キューから削除します。
int	size() このコレクション中の要素の数を返します。
E	take() このキューの先頭を取得および削除します。
Object[]	toArray() このコレクションの要素がすべて格納されている配列を返します。
<T> T[]	toArray(T[] a) このコレクション内のすべての要素を保持する配列を返します。
String	toString() このコレクションの文字列表現を返します。

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

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.Queue から継承されたメソッド

element, remove

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

addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll

コンストラクタの詳細

PriorityBlockingQueue

public PriorityBlockingQueue()

自然順序付けに従って要素を順序付けする (Comparable を使用)、デフォルトの初期容量 (11) を持つ PriorityBlockingQueue を作成します。

PriorityBlockingQueue

public PriorityBlockingQueue(int initialCapacity)

自然順序付けに従って要素を順序付けする (Comparable を使用)、指定された初期容量を持つ 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 を作成します。優先度キューの初期容量は、指定されたコレクションのサイズの 110% です。指定されたコレクションが SortedSet または PriorityQueue の場合、この優先度キューは同じコンパレータに従うか、その要素の自然順序に従って (コレクションが要素の自然順序に従ってソートされる場合) ソートされます。それ以外の場合は、この優先度キューはその要素の自然順序に従って順序付けされます。

パラメータ:

c - 要素が優先度キューに配置されるコレクション

例外:

ClassCastException - 指定されたコレクションの要素を、優先度キューの順序付けに従って相互に比較できない場合

NullPointerException - c またはその内部要素のいずれかが null の場合

メソッドの詳細

add

public boolean add(E o)

指定された要素をこのキューに追加します。

定義:

インタフェース Collection<E> 内の add

定義:

インタフェース BlockingQueue<E> 内の add

オーバーライド:

クラス AbstractQueue<E> 内の add

パラメータ:

o - 追加する要素

戻り値:

true (Collection.add の一般規約に従う)

例外:

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

ClassCastException - 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合

comparator

public Comparator<? super E> comparator()

コレクションの順序付けに使うコンパレータを返します。ただし、コレクションがその要素の自然順序付けに従って (Comparable を使用して) ソートされる場合は null を返します。

戻り値:

コレクションの順序付けに使うコンパレータ。ただし、コレクションがその要素の自然順序付けに従ってソートされる場合は null

offer

public boolean offer(E o)

指定された要素をこの優先度キューに挿入します。

定義:

インタフェース BlockingQueue<E> 内の offer

定義:

インタフェース Queue<E> 内の offer

パラメータ:

o - 追加する要素

戻り値:

true

例外:

ClassCastException - 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合

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

put

public void put(E o)

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

定義:

インタフェース BlockingQueue<E> 内の put

パラメータ:

o - 追加する要素

例外:

ClassCastException - 要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合

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

offer

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

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

定義:

インタフェース BlockingQueue<E> 内の offer

パラメータ:

o - 追加する要素

timeout - メソッドがブロックを実行することはないため、このパラメータは無視される

unit - メソッドがブロックを実行することはないため、このパラメータは無視される

戻り値:

true

例外:

ClassCastException - 要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合

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

take

public E take()
       throws InterruptedException

インタフェース BlockingQueue の記述:

このキューの先頭を取得および削除します。このキューに要素が存在しない場合は待機します。

定義:

インタフェース BlockingQueue<E> 内の take

戻り値:

キューの先頭

例外:

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

poll

public E poll()

インタフェース Queue の記述:

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

定義:

インタフェース Queue<E> 内の poll

戻り値:

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

poll

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

インタフェース BlockingQueue の記述:

このキューの先頭を取得および削除します。このキューに要素が存在しない場合は、必要に応じて指定された時間だけ待機します。

定義:

インタフェース BlockingQueue<E> 内の poll

パラメータ:

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

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

戻り値:

このキューの先頭。指定された待機時間が経過しても要素が存在しない場合は null

例外:

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

peek

public E peek()

インタフェース Queue の記述:

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

定義:

インタフェース Queue<E> 内の peek

戻り値:

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

size

public int size()

クラス AbstractCollection の記述:

このコレクション中の要素の数を返します。コレクションに Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。

定義:

インタフェース Collection<E> 内の size

定義:

クラス AbstractCollection<E> 内の size

戻り値:

コレクションの要素数

remainingCapacity

public int remainingCapacity()

PriorityBlockingQueue は容量制限がないため、常に Integer.MAX_VALUE を返します。

定義:

インタフェース BlockingQueue<E> 内の remainingCapacity

戻り値:

Integer.MAX_VALUE

remove

public boolean remove(Object o)

指定された要素の単一のインスタンスがある場合は、キューから削除します。

定義:

インタフェース Collection<E> 内の remove

オーバーライド:

クラス AbstractCollection<E> 内の remove

パラメータ:

o - コレクションから削除される要素 (その要素がある場合)

戻り値:

コレクションに指定された要素がある場合は true

contains

public boolean contains(Object o)

クラス AbstractCollection の記述:

コレクションに指定された要素がある場合に true を返します。すなわち、このコレクションに (o==null ? e==null : o.equals(e)) である要素 e が 1 つ以上ある場合にだけ true を返します。

この実装はコレクションの各要素について、指定された要素と等しいかどうかを順に繰り返し確認します。

定義:

インタフェース Collection<E> 内の contains

オーバーライド:

クラス AbstractCollection<E> 内の contains

パラメータ:

o - このコレクションにあるかどうかを調べるオブジェクト

戻り値:

コレクションに指定された要素がある場合は true

toArray

public Object[] toArray()

クラス AbstractCollection の記述:

このコレクションの要素がすべて格納されている配列を返します。反復子によって返される要素の順番をコレクションが保証する場合、このメソッドはそれと同じ順番で要素を返します。返される配列は、コレクションによって管理される参照関係を持たない点で安全性が保証されます。つまり、このメソッドは、コレクションの基が Array である場合でも、新しく配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。

この実装は、返される配列を割り当て、コレクションの各要素について繰り返します。つまり、各オブジェクト参照を配列の次の要素に格納するという処理を、第 0 要素から開始します。

定義:

インタフェース Collection<E> 内の toArray

オーバーライド:

クラス AbstractCollection<E> 内の toArray

戻り値:

コレクションのすべての要素が格納されている配列

toString

public String toString()

クラス AbstractCollection の記述:

このコレクションの文字列表現を返します。文字列表現は、コレクションの要素をその反復子が返した順に角括弧 ("[]") で囲んで示すリストです。隣接する要素は、文字 ", " (カンマと空白文字) によって区切られます。各要素は、String.valueOf(Object) を実行したかのように文字列に変換されます。

この実装は空の文字列バッファを作成し、最初に左角括弧を付加してから、コレクションの内容を次々調べて、各要素の文字列表現を順に付加していきます。各要素の後には、文字列 ", " が付加されます。ただし、最後の要素の後には、", " ではなく右角括弧が付加されます。最後に文字列バッファから文字列を取得し、その文字列を返します。

オーバーライド:

クラス AbstractCollection<E> 内の toString

戻り値:

このコレクションの文字列表現

drainTo

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

インタフェース BlockingQueue の記述:

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

定義:

インタフェース BlockingQueue<E> 内の drainTo

パラメータ:

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

戻り値:

転送される要素の数

drainTo

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

インタフェース BlockingQueue の記述:

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

定義:

インタフェース BlockingQueue<E> 内の drainTo

パラメータ:

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

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

戻り値:

転送される要素の数

clear

public void clear()

キューからすべての要素を原子的に削除します。この呼び出しが戻ると、キューは空になります。

定義:

インタフェース Collection<E> 内の clear

オーバーライド:

クラス AbstractQueue<E> 内の clear

toArray

public <T> T[] toArray(T[] a)

クラス AbstractCollection の記述:

このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。コレクションが指定された配列に収まる場合は、その中に返されます。そうでない場合は、指定された配列の実行時の型とコレクションのサイズを持つ新しい配列が割り当てられます。

指定された配列にコレクションが収まり、さらに空きがある場合、すなわち配列にコレクション以上の要素数がある場合には、コレクションの終端の直後にある配列の要素が null に設定されます。コレクションに null 要素がないことが呼び出し側でわかっている場合には、これにより、コレクションの長さを判定できます。

反復子によって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。

この実装は、配列がコレクションの格納に十分な大きさであるかを確認します。不十分な場合、この実装はリフレクションを使って、適切なサイズおよび型の配列を新しく割り当てます。次に、コレクションに対して、0 から順に配列の連続する要素へ各オブジェクト参照を格納する操作を反復します。配列がコレクションよりも大きい場合、コレクションの終端より後の最初の位置に null が格納されます。

定義:

インタフェース Collection<E> 内の toArray

オーバーライド:

クラス AbstractCollection<E> 内の toArray

パラメータ:

a - コレクションの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる

戻り値:

コレクションの要素を含む配列

iterator

public Iterator<E> iterator()

このキュー内の要素の反復子を返します。反復子が要素を返す特定の順序はありません。返される反復子はスレッドセーフで「ファストフェイル」な反復子であり、干渉を検出すると ConcurrentModificationException をスローします。

定義:

インタフェース Iterable<E> 内の iterator

定義:

インタフェース Collection<E> 内の iterator

定義:

クラス AbstractCollection<E> 内の iterator

戻り値:

キュー内の要素の反復子