モジュール java.base
パッケージ 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()で提供されるイテレータとメソッドspliterator()で提供される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(0);
   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
関連項目:
直列化された形式

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

    コンストラクタ 
    コンストラクタ 説明
    PriorityBlockingQueue()
    自然順序付けに従って要素を順序付けする、デフォルトの初期容量(11)を持つPriorityBlockingQueueを作成します。
    PriorityBlockingQueue​(int initialCapacity)
    自然順序付けに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueueを作成します。
    PriorityBlockingQueue​(int initialCapacity, Comparator<? super E> comparator)
    指定されたコンパレータに従って要素を順序付けする、指定された初期容量を持つPriorityBlockingQueueを作成します。
    PriorityBlockingQueue​(Collection<? extends E> c)
    指定されたコレクション内の要素を含むPriorityBlockingQueueを作成します。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    boolean add​(E e)
    指定された要素をこの優先度キューに挿入します。
    void clear()
    すべての要素をこのキューから原子的に削除します。
    Comparator<? super E> comparator()
    このキュー内の要素を順序付けするのに使うコンパレータを返します。ただし、このキューがその要素の自然順序付けを使う場合はnullを返します。
    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)
    指定された要素をこの優先度キューに挿入します。
    boolean offer​(E e, long timeout, TimeUnit unit)
    指定された要素をこの優先度キューに挿入します。
    void put​(E e)
    指定された要素をこの優先度キューに挿入します。
    int remainingCapacity()
    PriorityBlockingQueueは容量制約を受けないため、常にInteger.MAX_VALUEを返します。
    boolean remove​(Object o)
    指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
    boolean removeAll​(Collection<?> c)
    指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
    boolean removeIf​(Predicate<? super E> filter)
    指定された述語を満たすこのコレクションの要素をすべて削除します。
    boolean retainAll​(Collection<?> c)
    このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
    Spliterator<E> spliterator()
    このキュー内の要素に対するSpliteratorを返します。
    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.concurrent.BlockingQueueで宣言されたメソッド

    poll, take

    インタフェース java.util.Collectionで宣言されたメソッド

    addAll, containsAll, equals, hashCode, isEmpty, parallelStream, size, stream, toArray

    インタフェース java.util.Queueで宣言されたメソッド

    element, peek, poll, remove

  • コンストラクタの詳細

    • 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またはPriorityQueueである場合、この優先度キューの順序付けは、それと同じ順序付けに従って行われます。 それ以外の場合、この優先度キューの順序付けは、その要素の自然順序付けに従って行われます。
      パラメータ:
      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

      public boolean offer​(E e, long timeout, TimeUnit unit)
      指定された要素をこの優先度キューに挿入します。 キューがアンバウンド形式であるため、このメソッドはブロックを実行しないか、falseを返しません。
      定義:
      offer、インタフェース: BlockingQueue<E>
      パラメータ:
      e - 追加する要素
      timeout - メソッドがブロックを実行することはないため、このパラメータは無視される
      unit - メソッドがブロックを実行することはないため、このパラメータは無視される
      戻り値:
      true (BlockingQueue.offerで指定されているとおり)
      例外:
      ClassCastException - 指定された要素を、優先度キューに現在存在する要素と、優先度キューの順序付けに従って比較できない場合
      NullPointerException - 指定された要素がnullである場合

    • comparator

      public Comparator<? super E> comparator()
      このキュー内の要素を順序付けするのに使うコンパレータを返します。ただし、このキューがその要素の自然順序付けを使う場合はnullを返します。
      戻り値:
      このキュー内の要素を順序付けするのに使うコンパレータ。このキューがその要素の自然順序付けを使用する場合はnull

    • 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

      public Iterator<E> iterator()
      このキュー内の要素のイテレータを返します。 イテレータは特定の順序で要素を返しません。

      返されるイテレータは弱一貫性を保持します。

      定義:
      iterator、インタフェース: Collection<E>
      定義:
      iterator、インタフェース: Iterable<E>
      定義:
      iterator、クラス: AbstractCollection<E>
      戻り値:
      このキュー内の要素のイテレータ

    • 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

      public boolean removeIf​(Predicate<? super E> filter)
      次のインタフェースからコピーされた説明: 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)

    • forEach

      public void forEach​(Consumer<? super E> action)
      インタフェースからコピーされた説明: Iterable
      Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。

      オーバーライドするクラスが並行変更ポリシーを指定していない限り、アクションが要素の基本ソースを変更する副作用を実行する場合、このメソッドの動作は指定されていません。

      定義:
      forEach、インタフェース: Iterable<E>
      パラメータ:
      action - 各要素に対して実行されるアクション
      例外:
      NullPointerException - 指定されたアクションがnullである場合