TreeMap (Java Platform SE 7)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.TreeMap<K,V>

型パラメータ:
K - このマップで保持されるキーの型
V - マップされる値の型

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

Serializable, Cloneable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>
```
public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, Serializable
```
赤 - 黒ツリーに基づく NavigableMap 実装です。マップは、使用するコンストラクタに応じて、そのキーの自然順序付けに従って、またはマップ作成時に提供される Comparator によってソートされます。
この実装は、containsKey、get、put、remove の各オペレーションに保証済みの log(n) 時間コストを提供します。アルゴリズムは、Cormen、Leiserson、Rivest の「Introduction to Algorithms」のものに手を加えています。
ソートマップの場合と同様に、あるツリーマップが Map インタフェースを正しく実装するには、明示的なコンパレータが提供されているかどうかにかかわらず、そのツリーマップによって維持される順序付けが equals との一貫性のあるものでなければいけないことに注意してください。(equals との一貫性の正確な定義については、Comparable または Comparator を参照してください。)これは Map インタフェースが equals オペレーションに基づいて定義されるためですが、ソートマップはその compareTo (または compare) メソッドを使用してすべてのキー比較を実行するので、このメソッドによって等しいと見なされる 2 つのキーは、ソートマップから見ても同じものです。ソートマップの動作は、その順序付けが equals と一貫性がない場合でも明確に定義されていますが、Map インタフェースの一般規約には準拠していません。
この実装は synchronized されません。複数のスレッドが並行してマップにアクセスし、それらのスレッドの少なくとも 1 つが構造的にマップを変更する場合には、外部で同期をとる必要があります。構造的な変更とは、1 つ以上のマッピングを追加または削除するようなオペレーションです。既存のキーに関連付けられている値を変更する処理は、構造的な変更ではありません。これは通常、マップを自然にカプセル化する一部のオブジェクトで synchronized することによって達成されます。そのようなオブジェクトが存在しない場合は、Collections.synchronizedSortedMap メソッドを使用してマップを「ラップ」することをお勧めします。マップが誤って synchronized なしでアクセスされるのを防ぐために、作成時に行うことをお勧めします。
```
   SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));
```
このクラスのすべてのコレクションビューメソッドによって返されるコレクションの iterator メソッドによって返されるイテレータは、フェイルファストです。イテレータの作成後に、イテレータ自体の remove メソッド以外の方法でマップが構造的に変更されると、イテレータは ConcurrentModificationException をスローします。このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。
イテレータのフェイルファスト動作は実際には保証できません。一般的に、synchronized なしの並行変更がある場合、確実に保証することは不可能です。フェイルファストイテレータは、ベストエフォートベースで ConcurrentModificationException をスローします。したがって、正確を期すためにこの例外に依存するプログラムを書くことは誤りです。イテレータのフェイルファスト動作はバグを検出するためにのみ使用すべきです。
このクラス内のメソッドによって返されるすべての Map.Entry ペアとそのビューは、マッピングの生成時のスナップショットを表します。これらは Entry.setValue メソッドをサポートしていません。(ただし、関連するマップ内のマッピングは put を使って変更できることに注意すること。)
このクラスは、Java Collections Framework のメンバーです。
導入されたバージョン:

1.2

関連項目:
Map, HashMap, Hashtable, Comparable, Comparator, Collection, 直列化された形式

ネストされたクラスのサマリー
- クラス java.util.AbstractMap から継承されたネストされたクラス/インタフェース
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

コンストラクタ
コンストラクタと説明
`TreeMap()` キーの自然順序付けを使って、新しい空のツリーマップを構築します。
`TreeMap(Comparator<? super K> comparator)` 指定されたコンパレータに従って順序付けされた、新しい空のツリーマップを作成します。
`TreeMap(Map<? extends K,? extends V> m)` 指定されたマップと同じマッピングを持ち、そのキーの自然順序付けに従って順序付けされた新しいツリーマップを作成します。
`TreeMap(SortedMap<K,? extends V> m)` 指定されたソートマップと同じマッピングを持ち、同じ順序付けを使用する新しいツリーマップを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Map.Entry<K,V>`	`ceilingEntry(K key)` 指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、`null` を返します。
`K`	`ceilingKey(K key)` 指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合は `null` を返します。
`void`	`clear()` すべてのマッピングをマップから削除します。
`Object`	`clone()` `TreeMap` のインスタンスのシャローコピーを返します。
`Comparator<? super K>`	`comparator()` このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合は `null` を返します。
`boolean`	`containsKey(Object key)` 指定されたキーのマッピングがこのマップに含まれている場合に `true` を返します。
`boolean`	`containsValue(Object value)` このマップが 1 つまたは複数のキーと指定された値をマッピングしている場合に `true` を返します。
`NavigableSet<K>`	`descendingKeySet()` このマップに含まれるキーの逆順の `NavigableSet` ビューを返します。
`NavigableMap<K,V>`	`descendingMap()` このマップ内に保持されているマッピングの逆順のビューを返します。
`Set<Map.Entry<K,V>>`	`entrySet()` このマップに含まれるマッピングの `Set` ビューを返します。
`Map.Entry<K,V>`	`firstEntry()` このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、`null` を返します。
`K`	`firstKey()` マップ内に現在ある最初 (下端) のキーを返します。
`Map.Entry<K,V>`	`floorEntry(K key)` 指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、`null` を返します。
`K`	`floorKey(K key)` 指定されたキーと等しいかそれよりも小さいキーの中で最大のものを返します。そのようなキーが存在しない場合は `null` を返します。
`V`	`get(Object key)` 指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は `null` を返します。
`SortedMap<K,V>`	`headMap(K toKey)` このマップの `toKey` よりも確実に小さいキーを持つ部分のビューを返します。
`NavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)` このマップの `toKey` よりも小さいキー (`inclusive` が true の場合はそれよりも小さいかそれと等しいキー) を含む部分のビューを返します。
`Map.Entry<K,V>`	`higherEntry(K key)` 指定されたキーよりも確実に大きい、最小のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、`null` を返します。
`K`	`higherKey(K key)` 指定されたキーよりも確実に大きいキーの中で最小のものを返します。そのようなキーが存在しない場合は `null` を返します。
`Set<K>`	`keySet()` このマップに含まれるキーの `Set` ビューを返します。
`Map.Entry<K,V>`	`lastEntry()` このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、`null` を返します。
`K`	`lastKey()` マップ内に現在ある最後 (上端) のキーを返します。
`Map.Entry<K,V>`	`lowerEntry(K key)` 指定されたキーよりも確実に小さい、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、`null` を返します。
`K`	`lowerKey(K key)` 指定されたキーよりも確実に小さいキーの中で最大のものを返します。そのようなキーが存在しない場合は `null` を返します。
`NavigableSet<K>`	`navigableKeySet()` このマップに含まれるキーの `NavigableSet` ビューを返します。
`Map.Entry<K,V>`	`pollFirstEntry()` このマップ内の最小のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、`null` を返します。
`Map.Entry<K,V>`	`pollLastEntry()` このマップ内の最大のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、`null` を返します。
`V`	`put(K key, V value)` 指定された値と指定されたキーをこのマップに関連付けます。
`void`	`putAll(Map<? extends K,? extends V> map)` 指定されたマップからすべてのマッピングをマップにコピーします。
`V`	`remove(Object key)` キーのマッピングがあれば TreeMap から削除します。
`int`	`size()` このマップ内のキー値マッピングの数を返します。
`NavigableMap<K,V>`	`subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)` このマップの `fromKey` - `toKey` のキー範囲を持つ部分のビューを返します。
`SortedMap<K,V>`	`subMap(K fromKey, K toKey)` このマップの `fromKey` (これを含む) - `toKey` (これを含まない) のキー範囲を持つ部分のビューを返します。
`SortedMap<K,V>`	`tailMap(K fromKey)` このマップの `fromKey` 以上のキーを持つ部分のビューを返します。
`NavigableMap<K,V>`	`tailMap(K fromKey, boolean inclusive)` このマップの `fromKey` よりも大きいキー (`inclusive` が true の場合はそれよりも大きいかそれと等しいキー) を含む部分のビューを返します。
`Collection<V>`	`values()` このマップに含まれる値の `Collection` ビューを返します。

クラス java.util.AbstractMap から継承されたメソッド
equals, hashCode, isEmpty, toString

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

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

- コンストラクタの詳細
  - TreeMap
```
public TreeMap()
```
    キーの自然順序付けを使って、新しい空のツリーマップを構築します。このマップに挿入されるキーはすべて Comparable インタフェースを実装する必要があります。さらに、各キーは相互に比較可能である必要があります。つまり、k1.compareTo(k2) は、マップ内の k1 と k2 のどのキーに対しても ClassCastException をスローすべきではありません。たとえばキーが整数のマップに文字列キーを入れようとするなど、ユーザーがこの制約に違反するキーをマップに入れようとすると、put(Object key, Object value) の呼び出しが ClassCastException をスローします。
  - TreeMap
```
public TreeMap(Comparator<? super K> comparator)
```
    指定されたコンパレータに従って順序付けされた、新しい空のツリーマップを作成します。マップに挿入されたすべてのキーは、指定されたコンパレータによって相互に比較可能である必要があります。つまり、マップ内の任意のキー k1 と k2 に対して、comparator.compare(k1, k2) が ClassCastException をスローしてはいけません。ユーザーがこの制約に違反するキーをマップに入れようとすると、put(Object key, Object value) の呼び出しが ClassCastException をスローします。
    
    パラメータ:
    comparator - このマップの順序付けを行うために使用されるコンパレータ。null の場合、キーの自然順序付けが使用される。
  - TreeMap
```
public TreeMap(Map<? extends K,? extends V> m)
```
    指定されたマップと同じマッピングを持ち、そのキーの自然順序付けに従って順序付けされた新しいツリーマップを作成します。新しいマップに挿入されるキーはすべて Comparable インタフェースを実装する必要があります。さらに、各キーは相互に比較可能である必要があります。つまり、k1.compareTo(k2) は、マップ内の k1 と k2 のどのキーに対しても ClassCastException をスローすべきではありません。このメソッドは、n*log(n) 時間で実行されます。
    
    パラメータ:
    m - マッピングがこのマップに配置されるマップ
    
    例外:
    
    ClassCastException- m 内のキーが Comparable でないか、または相互に比較可能でない場合
    
    NullPointerException - 指定されたマップが null の場合
  - TreeMap
```
public TreeMap(SortedMap<K,? extends V> m)
```
    指定されたソートマップと同じマッピングを持ち、同じ順序付けを使用する新しいツリーマップを作成します。このメソッドは一次時間で動作します。
    
    パラメータ:
    m - マッピングがこのマップに配置され、コンパレータがこのマップのソートに使用される、ソートされたマップ
    
    例外:
    
    NullPointerException - 指定されたマップが null の場合
- メソッドの詳細
  - size
```
public int size()
```
    このマップ内のキー値マッピングの数を返します。
    
    定義:
    
    size、インタフェース: Map<K,V>
    
    オーバーライド:
    
    size、クラス: AbstractMap<K,V>
    
    戻り値:
    このマップ内のキーと値のマッピングの数
  - containsKey
```
public boolean containsKey(Object key)
```
    指定されたキーのマッピングがこのマップに含まれている場合に true を返します。
    
    定義:
    
    containsKey、インタフェース: Map<K,V>
    
    オーバーライド:
    
    containsKey、クラス: AbstractMap<K,V>
    
    パラメータ:
    key - このマップ内にあるかどうかが判定されるキー
    
    戻り値:
    指定されたキーのマッピングがこのマップに含まれている場合は true
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
  - containsValue
```
public boolean containsValue(Object value)
```
    このマップが 1 つまたは複数のキーと指定された値をマッピングしている場合に true を返します。つまり、このマップに (value==null ? v==null : value.equals(v)) となるような値 v へのマッピングが 1 つ以上ある場合に限り true を返します。ほとんどの実装では、このオペレーションはマップのサイズに正比例した時間がかかると考えられます。
    
    定義:
    
    containsValue、インタフェース: Map<K,V>
    
    オーバーライド:
    
    containsValue、クラス: AbstractMap<K,V>
    
    パラメータ:
    value - このマップにあるかどうかが判定される値
    
    戻り値:
    value へのマッピングが存在する場合は true。それ以外の場合は false
    導入されたバージョン:
    
    1.2
  - get
```
public V get(Object key)
```
    指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は null を返します。
    つまり、マップの順序付けに従って key が k に等しくなるような、キー k から値 v へのマッピングがこのマップに含まれている場合、このメソッドは v を返します。それ以外の場合は、null を返します。(このようなマッピングは 1 つのみ存在できます。)
    戻り値 null は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップすることもあります。containsKey オペレーションを使うと、これらの 2 つの場合を区別できます。
    
    定義:
    
    get、インタフェース: Map<K,V>
    
    オーバーライド:
    
    get、クラス: AbstractMap<K,V>
    
    パラメータ:
    key - 関連付けられた値が返されるキー
    
    戻り値:
    指定されたキーがマップされている値。そのキーのマッピングがこのマップに含まれていない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
  - comparator
```
public Comparator<? super K> comparator()
```
    インタフェースからコピーされた説明: SortedMap
    
    このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合は null を返します。
    
    定義:
    
    comparator、インタフェース: SortedMap<K,V>
    
    戻り値:
    このマップ内のキーを順序付けするのに使うコンパレータ。このマップがそのキーの自然順序付けを使う場合は null
  - firstKey
```
public K firstKey()
```
    インタフェースからコピーされた説明: SortedMap
    
    マップ内に現在ある最初 (下端) のキーを返します。
    
    定義:
    
    firstKey、インタフェース: SortedMap<K,V>
    
    戻り値:
    マップ内に現在ある最初 (下端) のキー
    
    例外:
    
    NoSuchElementException - マップが空の場合
  - lastKey
```
public K lastKey()
```
    インタフェースからコピーされた説明: SortedMap
    
    マップ内に現在ある最後 (上端) のキーを返します。
    
    定義:
    
    lastKey、インタフェース: SortedMap<K,V>
    
    戻り値:
    マップ内に現在ある最後 (上端) のキー
    
    例外:
    
    NoSuchElementException - マップが空の場合
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    指定されたマップからすべてのマッピングをマップにコピーします。これにより、マップが指定されたマップ内に現在あるキーのすべてに対して持っていたマッピングが置き換えられます。
    
    定義:
    
    putAll、インタフェース: Map<K,V>
    
    オーバーライド:
    
    putAll、クラス: AbstractMap<K,V>
    
    パラメータ:
    map - このマップに格納されるマッピング
    
    例外:
    
    ClassCastException - 指定されたマップ内のキーまたは値のクラスが原因で、このマップにそれらを格納できない場合
    
    NullPointerException - 指定されたマップが null である場合、または指定されたマップに null キーが含まれており、このマップが null キーを許可しない場合
  - put
```
public V put(K key,
    V value)
```
    指定された値と指定されたキーをこのマップに関連付けます。マップが以前にこのキーのマッピングを保持していた場合、古い値が置き換えられます。
    
    定義:
    
    put、インタフェース: Map<K,V>
    
    オーバーライド:
    
    put、クラス: AbstractMap<K,V>
    
    パラメータ:
    key - 指定された値が関連付けられるキー
    value - 指定されたキーに関連付けられる値
    
    戻り値:
    key に以前に関連付けられていた値。key のマッピングが存在しなかった場合は null。(戻り値 null は、マップが以前に null と key を関連付けていたことを示す場合もある)
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
  - remove
```
public V remove(Object key)
```
    キーのマッピングがあれば TreeMap から削除します。
    
    定義:
    
    remove、インタフェース: Map<K,V>
    
    オーバーライド:
    
    remove、クラス: AbstractMap<K,V>
    
    パラメータ:
    key - マッピングを削除する必要があるキー
    
    戻り値:
    key に以前に関連付けられていた値。key のマッピングが存在しなかった場合は null。(戻り値 null は、マップが以前に null と key を関連付けていたことを示す場合もある)
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
  - clear
```
public void clear()
```
    すべてのマッピングをマップから削除します。この呼び出しが戻ると、マップは空になります。
    
    定義:
    
    clear、インタフェース: Map<K,V>
    
    オーバーライド:
    
    clear、クラス: AbstractMap<K,V>
  - clone
```
public Object clone()
```
    TreeMap のインスタンスのシャローコピーを返します。そのキーと値は複製されません。
    
    オーバーライド:
    
    clone、クラス: AbstractMap<K,V>
    
    戻り値:
    このマップのシャローコピー
    関連項目:
    Cloneable
  - firstEntry
```
public Map.Entry<K,V> firstEntry()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null を返します。
    
    定義:
    
    firstEntry、インタフェース: NavigableMap<K,V>
    
    戻り値:
    最小のキーを持つエントリ。このマップが空の場合は null
    導入されたバージョン:
    
    1.6
  - lastEntry
```
public Map.Entry<K,V> lastEntry()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null を返します。
    
    定義:
    
    lastEntry、インタフェース: NavigableMap<K,V>
    
    戻り値:
    最大のキーを持つエントリ。このマップが空の場合は null
    導入されたバージョン:
    
    1.6
  - pollFirstEntry
```
public Map.Entry<K,V> pollFirstEntry()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップ内の最小のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null を返します。
    
    定義:
    
    pollFirstEntry、インタフェース: NavigableMap<K,V>
    
    戻り値:
    このマップの削除された最初のエントリ。このマップが空の場合は null
    導入されたバージョン:
    
    1.6
  - pollLastEntry
```
public Map.Entry<K,V> pollLastEntry()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップ内の最大のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null を返します。
    
    定義:
    
    pollLastEntry、インタフェース: NavigableMap<K,V>
    
    戻り値:
    このマップの削除された最後のエントリ。このマップが空の場合は null
    導入されたバージョン:
    
    1.6
  - lowerEntry
```
public Map.Entry<K,V> lowerEntry(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーよりも確実に小さい、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null を返します。
    
    定義:
    
    lowerEntry、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key よりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - lowerKey
```
public K lowerKey(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーよりも確実に小さいキーの中で最大のものを返します。そのようなキーが存在しない場合は null を返します。
    
    定義:
    
    lowerKey、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key よりも小さいキーの中で最大のもの。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - floorEntry
```
public Map.Entry<K,V> floorEntry(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null を返します。
    
    定義:
    
    floorEntry、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key と等しいか、それよりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - floorKey
```
public K floorKey(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーと等しいかそれよりも小さいキーの中で最大のものを返します。そのようなキーが存在しない場合は null を返します。
    
    定義:
    
    floorKey、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key と等しいか、それよりも小さいキーの中で最大のもの。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - ceilingEntry
```
public Map.Entry<K,V> ceilingEntry(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、null を返します。
    
    定義:
    
    ceilingEntry、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key と等しいか、それよりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - ceilingKey
```
public K ceilingKey(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合は null を返します。
    
    定義:
    
    ceilingKey、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key と等しいか、それよりも大きいキーの中で最小のもの。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - higherEntry
```
public Map.Entry<K,V> higherEntry(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーよりも確実に大きい、最小のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null を返します。
    
    定義:
    
    higherEntry、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key よりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - higherKey
```
public K higherKey(K key)
```
    インタフェースからコピーされた説明: NavigableMap
    
    指定されたキーよりも確実に大きいキーの中で最小のものを返します。そのようなキーが存在しない場合は null を返します。
    
    定義:
    
    higherKey、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    key - キー
    
    戻り値:
    key よりも大きいキーの中で最小のもの。そのようなキーが存在しない場合は null
    
    例外:
    
    ClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合
    
    NullPointerException - 指定されたキーが null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    導入されたバージョン:
    
    1.6
  - keySet
```
public Set<K> keySet()
```
    このマップに含まれるキーの Set ビューを返します。セットのイテレータは、キーを昇順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートされていません。
    
    定義:
    
    keySet、インタフェース: Map<K,V>
    
    定義:
    
    keySet、インタフェース: SortedMap<K,V>
    
    オーバーライド:
    
    keySet、クラス: AbstractMap<K,V>
    
    戻り値:
    マップに含まれているキーのセットビュー
  - navigableKeySet
```
public NavigableSet<K> navigableKeySet()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップに含まれるキーの NavigableSet ビューを返します。セットのイテレータは、キーを昇順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートされていません。
    
    定義:
    
    navigableKeySet、インタフェース: NavigableMap<K,V>
    
    戻り値:
    このマップ内のキーのナビゲート可能なセットビュー
    導入されたバージョン:
    
    1.6
  - descendingKeySet
```
public NavigableSet<K> descendingKeySet()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップに含まれるキーの逆順の NavigableSet ビューを返します。セットのイテレータは、キーを降順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートされていません。
    
    定義:
    
    descendingKeySet、インタフェース: NavigableMap<K,V>
    
    戻り値:
    このマップ内のキーのナビゲート可能な逆順セットビュー
    導入されたバージョン:
    
    1.6
  - values
```
public Collection<V> values()
```
    このマップに含まれる値の Collection ビューを返します。コレクションのイテレータは、値を対応するキーの昇順で返します。コレクションはマップと連動しているので、マップに対する変更はコレクションに反映され、またコレクションに対する変更はマップに反映されます。コレクションの反復処理中にマップが変更された場合、反復処理の結果は定義されません (イテレータ自身の remove オペレーションを除く)。コレクションは要素の削除をサポートしており、対応するマッピングをマップから削除できます。削除は、Iterator.remove、Collection.remove、removeAll、retainAll、および clear オペレーションを通して行います。add または addAll オペレーションはサポートされていません。
    
    定義:
    
    values、インタフェース: Map<K,V>
    
    定義:
    
    values、インタフェース: SortedMap<K,V>
    
    オーバーライド:
    
    values、クラス: AbstractMap<K,V>
    
    戻り値:
    マップ内に含まれている値のコレクションビュー
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    このマップに含まれるマッピングの Set ビューを返します。セットのイテレータは、エントリをキーの昇順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されません (イテレータ自身の remove オペレーション、またはイテレータにより返されるマップエントリに対する setValue オペレーションを除く)。セットは要素の削除をサポートしており、対応するマッピングをマップから削除できます。削除は、Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションを通して行います。add または addAll オペレーションはサポートされていません。
    
    定義:
    
    entrySet、インタフェース: Map<K,V>
    
    定義:
    
    entrySet、インタフェース: SortedMap<K,V>
    
    定義:
    
    entrySet、クラス: AbstractMap<K,V>
    
    戻り値:
    マップ内に保持されているマッピングのセットビュー
  - descendingMap
```
public NavigableMap<K,V> descendingMap()
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップ内に保持されているマッピングの逆順のビューを返します。降順マップはこのマップに連動しており、このマップでの変更は降順マップに反映され、その逆の場合も同様です。いずれかのマップのコレクションビューの反復処理中にいずれかのマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。
    返されるマップの順序付けは、Collections.reverseOrder(comparator()) と同等になります。式 m.descendingMap().descendingMap() から返される m のビューは基本的に m と同等になります。
    
    定義:
    
    descendingMap、インタフェース: NavigableMap<K,V>
    
    戻り値:
    このマップの逆順のビュー
    導入されたバージョン:
    
    1.6
  - subMap
```
public NavigableMap<K,V> subMap(K fromKey,
                       boolean fromInclusive,
                       K toKey,
                       boolean toInclusive)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの fromKey - toKey のキー範囲を持つ部分のビューを返します。fromKey と toKey が等しい場合、返されるマップは、fromInclusive と toInclusive の両方が true でないかぎり、空になります。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとしたり、端点のいずれかがその範囲外にあるようなサブマップが構築されようとしたりすると、IllegalArgumentException をスローします。
    
    定義:
    
    subMap、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    fromKey - 返されるマップ内のキーの下端点
    fromInclusive - 返されるビューに下端点が含まれる場合は true
    toKey - 返されるマップ内のキーの上端点
    toInclusive - 返されるビューに上端点が含まれる場合は true
    
    戻り値:
    このマップの fromKey - toKey のキー範囲を持つ部分のビュー
    
    例外:
    
    ClassCastException - このマップのコンパレータを使用して (このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKey と toKey の相互比較を行えない場合。実装は、マップ内に現在存在しているキーと fromKey または toKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromKey または toKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - fromKey が toKey よりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKey または toKey がその範囲から外れている場合
    導入されたバージョン:
    
    1.6
  - headMap
```
public NavigableMap<K,V> headMap(K toKey,
                        boolean inclusive)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの toKey よりも小さいキー (inclusive が true の場合はそれよりも小さいかそれと等しいキー) を含む部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException をスローします。
    
    定義:
    
    headMap、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    toKey - 返されるマップ内のキーの上端点
    inclusive - 返されるビューに上端点が含まれる場合は true
    
    戻り値:
    このマップの toKey よりも小さいキー (inclusive が true の場合はそれよりも小さいかそれと等しいキー) を含む部分のビュー
    
    例外:
    
    ClassCastException - toKey がこのマップのコンパレータと互換性がない場合 (または、そのマップがコンパレータを持たない場合、toKey が Comparable を実装していない場合)。実装は、マップ内に現在存在しているキーと toKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない
    
    NullPointerException - toKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - このマップ自体が制限された範囲を持っており、toKey がその範囲から外れている場合
    導入されたバージョン:
    
    1.6
  - tailMap
```
public NavigableMap<K,V> tailMap(K fromKey,
                        boolean inclusive)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの fromKey よりも大きいキー (inclusive が true の場合はそれよりも大きいかそれと等しいキー) を含む部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException をスローします。
    
    定義:
    
    tailMap、インタフェース: NavigableMap<K,V>
    
    パラメータ:
    fromKey - 返されるマップ内のキーの下端点
    inclusive - 返されるビューに下端点が含まれる場合は true
    
    戻り値:
    このマップの fromKey よりも大きいキー (inclusive が true の場合はそれよりも大きいかそれと等しいキー) を含む部分のビュー
    
    例外:
    
    ClassCastException - fromKey がこのマップのコンパレータと互換性がない場合 (または、そのマップがコンパレータを持たない場合、fromKey が Comparable を実装していない場合)。実装は、マップ内に現在存在しているキーと fromKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない
    
    NullPointerException - fromKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - このマップ自体が制限された範囲を持っており、fromKey がその範囲から外れている場合
    導入されたバージョン:
    
    1.6
  - subMap
```
public SortedMap<K,V> subMap(K fromKey,
                    K toKey)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの fromKey (これを含む) - toKey (これを含まない) のキー範囲を持つ部分のビューを返します。fromKey と toKey が等しい場合は、空のマップが返されます。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException をスローします。
    subMap(fromKey, true, toKey, false) と同等です。
    
    定義:
    
    subMap、インタフェース: NavigableMap<K,V>
    
    定義:
    
    subMap、インタフェース: SortedMap<K,V>
    
    パラメータ:
    fromKey - 返されるマップ内のキーの下端点 (これを含む)
    toKey - 返されるマップ内のキーの上端点 (これを含まない)
    
    戻り値:
    このマップの fromKey (これを含む) から toKey (これを含まない) のキー範囲を持つ部分のビュー
    
    例外:
    
    ClassCastException - このマップのコンパレータを使用して (このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKey と toKey の相互比較を行えない場合。実装は、マップ内に現在存在しているキーと fromKey または toKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromKey または toKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - fromKey が toKey よりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKey または toKey がその範囲から外れている場合
  - headMap
```
public SortedMap<K,V> headMap(K toKey)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの toKey よりも確実に小さいキーを持つ部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException をスローします。
    headMap(toKey, false) と同等です。
    
    定義:
    
    headMap、インタフェース: NavigableMap<K,V>
    
    定義:
    
    headMap、インタフェース: SortedMap<K,V>
    
    パラメータ:
    toKey - 返されるマップ内のキーの上端点 (これを含まない)
    
    戻り値:
    このマップの toKey よりも確実に小さいキーを持つ部分のビュー
    
    例外:
    
    ClassCastException - toKey がこのマップのコンパレータと互換性がない場合 (または、そのマップがコンパレータを持たない場合、toKey が Comparable を実装していない場合)。実装は、マップ内に現在存在しているキーと toKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない
    
    NullPointerException - toKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - このマップ自体が制限された範囲を持っており、toKey がその範囲から外れている場合
  - tailMap
```
public SortedMap<K,V> tailMap(K fromKey)
```
    インタフェースからコピーされた説明: NavigableMap
    
    このマップの fromKey 以上のキーを持つ部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップオペレーションをすべてサポートします。
    返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException をスローします。
    tailMap(fromKey, true) と同等です。
    
    定義:
    
    tailMap、インタフェース: NavigableMap<K,V>
    
    定義:
    
    tailMap、インタフェース: SortedMap<K,V>
    
    パラメータ:
    fromKey - 返されるマップ内のキーの下端点 (これを含む)
    
    戻り値:
    このマップの fromKey 以上のキーを持つ部分のビュー
    
    例外:
    
    ClassCastException - fromKey がこのマップのコンパレータと互換性がない場合 (または、そのマップがコンパレータを持たない場合、fromKey が Comparable を実装していない場合)。実装は、マップ内に現在存在しているキーと fromKey とを比較できない場合にこの例外をスローできる。ただし、必須ではない
    
    NullPointerException - fromKey が null であり、このマップが自然順序付けを使用しているかそのコンパレータが null キーを許可しない場合
    
    IllegalArgumentException - このマップ自体が制限された範囲を持っており、fromKey がその範囲から外れている場合

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

クラス TreeMap<K,V>

ネストされたクラスのサマリー

クラス java.util.AbstractMap から継承されたネストされたクラス/インタフェース

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

TreeMap

TreeMap

TreeMap

TreeMap

メソッドの詳細

size

containsKey

containsValue

get

comparator

firstKey

lastKey

putAll

put

remove

clear

clone

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

lowerEntry

lowerKey

floorEntry

floorKey

ceilingEntry

ceilingKey

higherEntry

higherKey

keySet

navigableKeySet

descendingKeySet

values

entrySet

descendingMap

subMap

headMap

tailMap

subMap

headMap

tailMap