PriorityQueue (Java Platform SE 7)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<E>
  - - java.util.PriorityQueue<E>

型パラメータ:
E - このコレクション内に保持される要素の型

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

Serializable, Iterable<E>, Collection<E>, Queue<E>
```
public class PriorityQueue<E>
extends AbstractQueue<E>
implements Serializable
```
優先度ヒープに基づく、制限なしの優先度キューです。優先度キューの要素の順序付けは、自然順序付けに従って行われるか、キュー構築時に提供される Comparator を使って行われます。そのどちらになるかは、使用するコンストラクタによって決まります。優先度キューでは、null 要素は許可されません。自然順序付けに基づく優先度キューでは、比較不可能なオブジェクトの挿入も許可されません (実行すると ClassCastException がスローされることがある)。
このキューの先頭は、指定された順序付けの最小要素です。複数の要素が最小の値に結び付けられている場合、先頭はこれらの要素の 1 つになります。結び付きの解除は任意です。キューの取得オペレーション poll、remove、peek、および element は、キューの先頭の要素にアクセスします。
優先度キューには制限はありませんが、要素をキューに格納するのに使用する配列サイズを制御する内部容量は存在します。どのような場合でも、これはキューのサイズと常に同じ大きさです。要素は優先度キューに追加されるため、容量は自動的に大きくなります。拡大ポリシーの詳細は、指定されません。
このクラスとそのイテレータは、Collection および Iterator インタフェースの任意メソッドすべてを実装します。iterator() メソッド内で提供される Iterator では、特定の順序で優先度キューの要素をトラバースすることは保証されません。要素をトラバースする順序を指定する必要がある場合は、Arrays.sort(pq.toArray()) の使用を考慮してください。
この実装は synchronized されません。いずれかのスレッドがキューを変更する場合は、複数のスレッドが PriorityQueue インスタンスに並行してアクセスしてはいけません。代わりに、スレッドセーフな PriorityBlockingQueue クラスを使用してください。
実装にあたっての注意:この実装は、キューへの登録/登録解除メソッド (offer、poll、remove()、および add) では O(log(n)) 時間を、remove(Object) および contains(Object) メソッドでは線形時間を、取得メソッド (peek、element、および size) では一定時間を、それぞれ提供します。
このクラスは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.5

関連項目:
直列化された形式

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

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

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`boolean`	`add(E e)` 指定された要素をこの優先度キューに挿入します。
`void`	`clear()` すべての要素をこの優先度キューから削除します。
`Comparator<? super E>`	`comparator()` このキュー内の要素を順序付けするために使うコンパレータを返します。ただし、このキューがその要素の自然順序付けに従ってソートされる場合は `null` を返します。
`boolean`	`contains(Object o)` 指定された要素がキューに含まれている場合に `true` を返します。
`Iterator<E>`	`iterator()` このキュー内の要素のイテレータを返します。
`boolean`	`offer(E e)` 指定された要素をこの優先度キューに挿入します。
`E`	`peek()` キューの先頭を取得しますが、削除しません。キューが空の場合は `null` を返します。
`E`	`poll()` キューの先頭を取得および削除します。キューが空の場合は `null` を返します。
`boolean`	`remove(Object o)` 指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。
`int`	`size()` このコレクション中の要素の数を返します。
`Object[]`	`toArray()` このキューの要素がすべて含まれている配列を返します。
`<T> T[]`	`toArray(T[] a)` このキュー内のすべての要素を含む配列を返します。返される配列の実行時の型は、指定された配列の型です。

クラス java.util.AbstractQueue から継承されるメソッド
addAll, element, remove

クラス java.util.AbstractCollection から継承されたメソッド
containsAll, isEmpty, removeAll, retainAll, toString

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェース java.util.Collection から継承されたメソッド
containsAll, equals, hashCode, isEmpty, removeAll, retainAll

- コンストラクタの詳細
  - PriorityQueue
```
public PriorityQueue()
```
    自然順序付けに従って要素を順序付けする、デフォルトの初期容量 (11) を持つ PriorityQueue を作成します。
  - PriorityQueue
```
public PriorityQueue(int initialCapacity)
```
    自然順序付けに従って要素を順序付けする、指定された初期容量を持つ PriorityQueue を作成します。
    
    パラメータ:
    initialCapacity - この優先度キューの初期容量
    
    例外:
    
    IllegalArgumentException - initialCapacity が 1 より小さい場合
  - PriorityQueue
```
public PriorityQueue(int initialCapacity,
             Comparator<? super E> comparator)
```
    指定されたコンパレータに従って要素を順序付けする、指定された初期容量を持つ PriorityQueue を作成します。
    
    パラメータ:
    initialCapacity - この優先度キューの初期容量
    comparator - この優先度キューを順序付けするために使用されるコンパレータ。null の場合、要素の自然順序付けが使用される。
    
    例外:
    
    IllegalArgumentException - initialCapacity が 1 より小さい場合
  - PriorityQueue
```
public PriorityQueue(Collection<? extends E> c)
```
    指定されたコレクション内の要素を含む PriorityQueue を作成します。指定されたコレクションが SortedSet のインスタンスであるか別の PriorityQueue である場合、この優先度キューの順序付けは、それと同じ順序付けに従って行われます。それ以外の場合、この優先度キューの順序付けは、その要素の自然順序付けに従って行われます。
    
    パラメータ:
    c - 要素がこの優先度キューに配置されるコレクション
    
    例外:
    
    ClassCastException - 指定されたコレクションの要素を優先度キューの順序付けに従って相互比較できない場合
    
    NullPointerException - 指定されたコレクションまたはそのいずれかの要素が null である場合
  - PriorityQueue
```
public PriorityQueue(PriorityQueue<? extends E> c)
```
    指定された優先度キュー内の要素を含む PriorityQueue を作成します。この優先度キューの順序付けは、指定された優先度キューと同じ順序付けに従って行われます。
    
    パラメータ:
    c - 要素がこの優先度キューに配置される優先度キュー
    
    例外:
    
    ClassCastException - c の要素をc の順序付けに従って相互比較できない場合
    
    NullPointerException - 指定された優先度キューまたはそのいずれかの要素が null である場合
  - PriorityQueue
```
public PriorityQueue(SortedSet<? extends E> c)
```
    指定されたソートセット内の要素を含む PriorityQueue を作成します。この優先度キューの順序付けは、指定されたソートセットと同じ順序付けに従って行われます。
    
    パラメータ:
    c - 要素が優先度キューに配置されるソートセット
    
    例外:
    
    ClassCastException - 指定されたソートセットの要素をそのソートセットの順序付けに従って相互比較できない場合
    
    NullPointerException - 指定されたソートセット、またはその要素のいずれかが null の場合
- メソッドの詳細
  - add
```
public boolean add(E e)
```
    指定された要素をこの優先度キューに挿入します。
    
    定義:
    
    add、インタフェース: Collection<E>
    
    定義:
    
    add、インタフェース: Queue<E>
    
    オーバーライド:
    
    add、クラス: AbstractQueue<E>
    
    パラメータ:
    e - 追加する要素
    
    戻り値:
    true (Collection.add(E) で指定されているとおり)
    
    例外:
    
    ClassCastException - 指定された要素と、この優先度キュー内に現在存在している要素との比較を、この優先度キューの順序付けに従って行えない場合
    
    NullPointerException - 指定された要素が null である場合
  - offer
```
public boolean offer(E e)
```
    指定された要素をこの優先度キューに挿入します。
    
    定義:
    
    offer、インタフェース: Queue<E>
    
    パラメータ:
    e - 追加する要素
    
    戻り値:
    true (Queue.offer(E) で指定されているとおり)
    
    例外:
    
    ClassCastException - 指定された要素と、この優先度キュー内に現在存在している要素との比較を、この優先度キューの順序付けに従って行えない場合
    
    NullPointerException - 指定された要素が null である場合
  - peek
```
public E peek()
```
    インタフェースからコピーされた説明: Queue
    
    キューの先頭を取得しますが、削除しません。キューが空の場合は null を返します。
    
    定義:
    
    peek、インタフェース: Queue<E>
    
    戻り値:
    キューの先頭。キューが空の場合は null
  - remove
```
public boolean remove(Object o)
```
    指定された要素の単一のインスタンスがこのキューに存在する場合は、キューから削除します。つまり、キュー内に、o.equals(e) に該当する要素 e が 1 つ以上含まれている場合は、そのような要素を削除します。指定された要素がこのキューに含まれていた場合 (つまり、呼び出しの結果としてこのキューが変更された場合) にのみ true を返します。
    
    定義:
    
    remove、インタフェース: Collection<E>
    
    オーバーライド:
    
    remove、クラス: AbstractCollection<E>
    
    パラメータ:
    o - キューから削除される要素 (その要素が存在する場合)
    
    戻り値:
    この呼び出しの結果、このキューが変更された場合は true
  - contains
```
public boolean contains(Object o)
```
    指定された要素がキューに含まれている場合に true を返します。つまり、このキュー内に o.equals(e) のような 1 つ以上の要素 e が含まれている場合、true を返します。
    
    定義:
    
    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>
    
    パラメータ:
    a - 配列が十分な大きさを持つ場合は、キューの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。
    
    戻り値:
    このキューのすべての要素が含まれている配列
    
    例外:
    
    ArrayStoreException - 指定された配列の実行時の型が、このキュー内の各要素の実行時の型のスーパータイプでない場合
    
    NullPointerException - 指定された配列が null である場合
  - iterator
```
public Iterator<E> iterator()
```
    このキュー内の要素のイテレータを返します。イテレータは特定の順序で要素を返しません。
    
    定義:
    
    iterator、インタフェース: Iterable<E>
    
    定義:
    
    iterator、インタフェース: Collection<E>
    
    定義:
    
    iterator、クラス: AbstractCollection<E>
    
    戻り値:
    このキュー内の要素のイテレータ
  - size
```
public int size()
```
    インタフェースからコピーされた説明: Collection
    
    このコレクション中の要素の数を返します。このコレクションに Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。
    
    定義:
    
    size、インタフェース: Collection<E>
    
    定義:
    
    size、クラス: AbstractCollection<E>
    
    戻り値:
    このコレクションの要素数
  - clear
```
public void clear()
```
    すべての要素をこの優先度キューから削除します。この呼び出しが戻ると、キューは空になります。
    
    定義:
    
    clear、インタフェース: Collection<E>
    
    オーバーライド:
    
    clear、クラス: AbstractQueue<E>
  - poll
```
public E poll()
```
    インタフェースからコピーされた説明: Queue
    
    キューの先頭を取得および削除します。キューが空の場合は null を返します。
    
    定義:
    
    poll、インタフェース: Queue<E>
    
    戻り値:
    キューの先頭。キューが空の場合は null
  - comparator
```
public Comparator<? super E> comparator()
```
    このキュー内の要素を順序付けするために使うコンパレータを返します。ただし、このキューがその要素の自然順序付けに従ってソートされる場合は null を返します。
    
    戻り値:
    このキューを順序付けするのに使うコンパレータ。ただし、このキューがその要素の自然順序付けに従ってソートされる場合は null

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス PriorityQueue<E>

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

メソッドのサマリー

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

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

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

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

コンストラクタの詳細

PriorityQueue

PriorityQueue

PriorityQueue

PriorityQueue

PriorityQueue

PriorityQueue

メソッドの詳細

add

offer

peek

remove

contains

toArray

toArray

iterator

size

clear

poll

comparator