- 型パラメータ:
K
- このマップで保持されるキーの型V
- マップされる値の型
- すべての実装されたインタフェース:
Serializable
,Cloneable
,Map<K,V>
,NavigableMap<K,V>
,SortedMap<K,V>
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
をスローします。 このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。
通常、非同期の並行変更がある場合、確かな保証を行うことは不可能なので、イテレータのフェイルファストの動作を保証することはできません。 フェイルファスト・イテレータは、ベスト・エフォート・ベースで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)
指定されたコンパレータに従って順序付けされた、新しい空のツリー・マップを作成します。指定されたマップと同じマッピングを持ち、そのキーの自然順序付けに従って順序付けされた新しいツリー・マップを作成します。指定されたソート・マップと同じマッピングを持ち、同じ順序付けを使用する新しいツリー・マップを作成します。 -
メソッドのサマリー
修飾子と型メソッド説明ceilingEntry(K key)
指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。ceilingKey(K key)
指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnull
を返します。void
clear()
すべてのマッピングをマップから削除します。clone()
TreeMap
のインスタンスのシャロー・コピーを返します。Comparator<? super K>
このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合はnull
を返します。指定されたキーと現在マップされている値に対するマッピングの計算を試みます(現在のマッピングが存在しない場合はnull
)。computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
指定されたキーがまだ値に関連付けられていない(またはnull
にマップされている)場合、指定されたマッピング関数を使用してその値の計算を試行し、null
でない場合はそれをこのマップに入力します。computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
指定されたキーの値が存在していてnull以外の場合、キーと現在マップされている値から新しいマッピングの計算を試みます。boolean
containsKey(Object key)
指定されたキーのマッピングがこのマップに含まれている場合にtrue
を返します。boolean
containsValue(Object value)
このマップが1つまたは複数のキーと指定された値をマッピングしている場合にtrue
を返します。このマップに含まれるキーの逆順のNavigableSet
ビューを返します。NavigableMap<K,V>
このマップ内に保持されているマッピングの逆順のビューを返します。entrySet()
このマップに含まれるマッピングのSet
ビューを返します。このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null
を返します。firstKey()
マップ内に現在ある最初(下端)のキーを返します。floorEntry(K key)
指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。指定されたキーと等しいかそれよりも小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnull
を返します。指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合はnull
を返します。このマップのtoKey
よりも確実に小さいキーを持つ部分のビューを返します。NavigableMap<K,V>
このマップのtoKey
よりも小さいキー(inclusive
がtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビューを返します。higherEntry(K key)
指定されたキーよりも確実に大きい、最小のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。指定されたキーよりも確実に大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnull
を返します。keySet()
このマップに含まれるキーのSet
ビューを返します。このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null
を返します。lastKey()
マップ内に現在ある最後(上端)のキーを返します。lowerEntry(K key)
指定されたキーよりも確実に小さい、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。指定されたキーよりも確実に小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnull
を返します。指定されたキーがまだ値と関連付けられていないかnullと関連付けられている場合、指定されたnull以外の値に関連付けます。このマップに含まれるキーのNavigableSet
ビューを返します。このマップ内の最小のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null
を返します。このマップ内の最大のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null
を返します。指定された値と指定されたキーをこのマップに関連付けます。void
指定されたマップからすべてのマッピングをマップにコピーします。キーのマッピングがあればTreeMapから削除します。int
size()
このマップ内のキー値マッピングの数を返します。NavigableMap<K,V>
このマップのfromKey
-toKey
のキー範囲を持つ部分のビューを返します。このマップのfromKey
(これを含む) -toKey
(これを含まない)のキー範囲を持つ部分のビューを返します。このマップのfromKey
以上のキーを持つ部分のビューを返します。NavigableMap<K,V>
このマップのfromKey
よりも大きいキー(inclusive
がtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。values()
このマップに含まれる値のCollection
ビューを返します。クラス java.util.AbstractMapで宣言されたメソッド
equals, hashCode, isEmpty, toString
インタフェース java.util.Mapで宣言されたメソッド
equals, forEach, getOrDefault, hashCode, isEmpty, putIfAbsent, remove, replace, replace, replaceAll
-
コンストラクタの詳細
-
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
指定されたマップと同じマッピングを持ち、そのキーの自然順序付けに従って順序付けされた新しいツリー・マップを作成します。 新しいマップに挿入されるキーはすべてComparable
インタフェースを実装する必要があります。 さらに、各キーは相互に比較可能である必要があります。つまり、k1.compareTo(k2)
は、マップ内のk1
とk2
のどのキーに対してもClassCastException
をスローすべきではありません。 このメソッドは、n*log(n)時間で実行されます。- パラメータ:
m
- マッピングがこのマップに配置されるマップ- 例外:
ClassCastException
- m内のキーがComparable
でないか、または相互に比較可能でない場合NullPointerException
- 指定されたマップがnullの場合
-
TreeMap
指定されたソート・マップと同じマッピングを持ち、同じ順序付けを使用する新しいツリー・マップを作成します。 このメソッドは一次時間で動作します。- パラメータ:
m
- マッピングがこのマップに配置され、コンパレータがこのマップのソートに使用される、ソートされたマップ- 例外:
NullPointerException
- 指定されたマップがnullの場合
-
-
メソッドの詳細
-
size
public int size()このマップ内のキー値マッピングの数を返します。 -
containsKey
public boolean containsKey(Object key)指定されたキーのマッピングがこのマップに含まれている場合にtrue
を返します。- 定義:
- インタフェース
Map<K,V>
内のcontainsKey
- オーバーライド:
- クラス
AbstractMap<K,V>
のcontainsKey
- パラメータ:
key
- このマップ内にあるかどうかが判定されるキー- 戻り値:
- 指定されたキーのマッピングがこのマップに含まれている場合は
true
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合
-
containsValue
public boolean containsValue(Object value)このマップが1つまたは複数のキーと指定された値をマッピングしている場合にtrue
を返します。 つまり、このマップに(value==null ? v==null : value.equals(v))
となるような値v
へのマッピングが1つ以上ある場合に限りtrue
を返します。 ほとんどの実装では、このオペレーションはマップのサイズに正比例した時間がかかると考えられます。- 定義:
- インタフェース
Map<K,V>
内のcontainsValue
- オーバーライド:
- クラス
AbstractMap<K,V>
のcontainsValue
- パラメータ:
value
- このマップにあるかどうかが判定される値- 戻り値:
value
へのマッピングが存在する場合はtrue
。それ以外の場合はfalse
- 導入されたバージョン:
- 1.2
-
get
指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合はnull
を返します。つまり、マップの順序付けに従って
key
がk
に等しくなるような、キーk
から値v
へのマッピングがこのマップに含まれている場合、このメソッドはv
を返します。それ以外の場合は、null
を返します。 (このようなマッピングは1つのみ存在できます。)戻り値
null
は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーをnull
にマップすることもあります。containsKey
操作を使うと、これら2つのケースを見分けることができます。- 定義:
- インタフェース
Map<K,V>
内のget
- オーバーライド:
- クラス
AbstractMap<K,V>
のget
- パラメータ:
key
- 関連付けられた値が返されるキー- 戻り値:
- 指定されたキーがマップされている値。そのキーのマッピングがこのマップに含まれていない場合は
null
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合
-
comparator
public Comparator<? super K> comparator()インタフェースからコピーされた説明:SortedMap
このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合はnull
を返します。- 定義:
- インタフェース
SortedMap<K,V>
内のcomparator
- 戻り値:
- このマップ内のキーを順序付けするのに使うコンパレータ。このマップがそのキーの自然順序付けを使う場合は
null
-
firstKey
public K firstKey()インタフェースからコピーされた説明:SortedMap
マップ内に現在ある最初(下端)のキーを返します。- 定義:
- インタフェース
SortedMap<K,V>
内のfirstKey
- 戻り値:
- マップ内に現在ある最初(下端)のキー
- 例外:
NoSuchElementException
- マップが空の場合
-
lastKey
public K lastKey()インタフェースからコピーされた説明:SortedMap
マップ内に現在ある最後(上端)のキーを返します。- 定義:
- インタフェース
SortedMap<K,V>
内のlastKey
- 戻り値:
- マップ内に現在ある最後(上端)のキー
- 例外:
NoSuchElementException
- マップが空の場合
-
putAll
指定されたマップからすべてのマッピングをマップにコピーします。 これにより、マップが指定されたマップ内に現在あるキーのすべてに対して持っていたマッピングが置き換えられます。- 定義:
- インタフェース
Map<K,V>
内のputAll
- オーバーライド:
- クラス
AbstractMap<K,V>
のputAll
- パラメータ:
map
- このマップに格納されるマッピング- 例外:
ClassCastException
- 指定されたマップ内のキーまたは値のクラスが原因で、このマップにそれらを格納できない場合NullPointerException
- 指定されたマップがnullである場合、または指定されたマップにnullキーが含まれており、このマップがnullキーを許可しない場合
-
put
指定された値と指定されたキーをこのマップに関連付けます。 マップが以前にこのキーのマッピングを保持していた場合、古い値が置き換えられます。- 定義:
- インタフェース
Map<K,V>
内のput
- オーバーライド:
- クラス
AbstractMap<K,V>
のput
- パラメータ:
key
- 指定された値が関連付けられるキーvalue
- 指定されたキーに関連付けられる値- 戻り値:
key
に以前に関連付けられていた値。key
のマッピングが存在しなかった場合はnull
。 (戻り値null
は、マップが以前にnull
とkey
を関連付けていたことを示す場合もある)- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合
-
computeIfAbsent
指定されたキーがまだ値に関連付けられていない(またはnull
にマップされている)場合、指定されたマッピング関数を使用してその値の計算を試行し、null
でない場合はそれをこのマップに入力します。マッピング関数が
null
を返した場合、マッピングは記録されません。 マッピング関数自体が(unchecked)例外をスローすると、例外は再スローされ、マッピングは記録されません。 もっとも一般的な用途は、次のように初期のマップされた値またはメモ化された結果として機能する新しいオブジェクトを構築することです。map.computeIfAbsent(key, k -> new Value(f(k)));
または、1つのキーで複数の値をサポートする複数値マップ
Map<K,Collection<V>>
を実装することです。map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);
マッピング関数は、計算中にこのマップを変更すべきではありません。
このメソッドは、最善の努力で、マッピング関数が計算中にこのマップを変更することが検出された場合に
ConcurrentModificationException
をスローします。- 定義:
- インタフェース
Map<K,V>
内のcomputeIfAbsent
- パラメータ:
key
- 指定された値が関連付けられるキーmappingFunction
- 値をコンピュートするマッピング関数- 戻り値:
- 指定されたキーに関連付けられている現在の(既存の、または計算された)値。計算された値がnullである場合はnull
- 例外:
ConcurrentModificationException
- マップ機能がこのマップを変更したことが検出された場合
-
computeIfPresent
指定されたキーの値が存在していてnull以外の場合、キーと現在マップされている値から新しいマッピングの計算を試みます。リマッピング関数が
null
を返した場合、マッピングは削除されます。 再マップ関数自体が(unchecked)例外をスローすると、例外が再スローされ、現在のマッピングは変更されません。再マップ関数は、計算中にこのマップを変更すべきではありません。
このメソッドは、リマップ関数が計算中にこのマップを変更することが検出された場合、ベスト・エフォート・ベースで
ConcurrentModificationException
をスローします。- 定義:
- インタフェース
Map<K,V>
内のcomputeIfPresent
- パラメータ:
key
- 指定された値が関連付けられるキーremappingFunction
- 値をコンピュートするための再マップ関数- 戻り値:
- 指定されたキーに関連付けられる新しい値。存在しない場合はnull
- 例外:
ConcurrentModificationException
- リマッピング機能がこのマップを変更したことが検出された場合
-
compute
指定されたキーと現在マップされている値に対するマッピングの計算を試みます(現在のマッピングが存在しない場合はnull
)。 たとえば、次のように、値のマッピングにString
msgを作成または追加します。map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))
merge()
メソッドは、多くの場合、より単純です。)再マッピング関数が
null
を返した場合、マッピングは削除されます。(最初に欠席した場合は不在のままです)。 再マップ関数自体が(unchecked)例外をスローすると、例外が再スローされ、現在のマッピングは変更されません。再マップ関数は、計算中にこのマップを変更すべきではありません。
このメソッドは、リマップ関数が計算中にこのマップを変更することが検出された場合、ベスト・エフォート・ベースで
ConcurrentModificationException
をスローします。- 定義:
- インタフェース
Map<K,V>
内のcompute
- パラメータ:
key
- 指定された値が関連付けられるキーremappingFunction
- 値をコンピュートするための再マップ関数- 戻り値:
- 指定されたキーに関連付けられる新しい値。存在しない場合はnull
- 例外:
ConcurrentModificationException
- リマッピング機能がこのマップを変更したことが検出された場合
-
merge
指定されたキーがまだ値と関連付けられていないかnullと関連付けられている場合、指定されたnull以外の値に関連付けます。 それ以外の場合は、指定された再マッピング関数の結果で関連する値を置換し、結果がnull
の場合は削除します。 このメソッドは、1つのキーに対する複数のマップされた値を結合するときに使用できます。 たとえば、次のように、値のマッピングにString msg
を作成または追加します。map.merge(key, msg, String::concat)
リマッピング関数が
null
を返した場合、マッピングは削除されます。 再マップ関数自体が(unchecked)例外をスローすると、例外が再スローされ、現在のマッピングは変更されません。再マップ関数は、計算中にこのマップを変更すべきではありません。
このメソッドは、リマップ関数が計算中にこのマップを変更することが検出された場合、ベスト・エフォート・ベースで
ConcurrentModificationException
をスローします。- 定義:
- インタフェース
Map<K,V>
内のmerge
- パラメータ:
key
- 結果値が関連付けられるキーvalue
- キーに関連付けられた既存の値にマージされるnull以外の値。既存の値がない場合、またはキーにnull値が関連付けられている場合は、キーに関連付けられるnull以外の値remappingFunction
- 存在する場合に値を再計算するための再マッピング関数- 戻り値:
- 指定されたキーに関連付けられた新しい値。キーに値が関連付けられなかった場合はnull
- 例外:
ConcurrentModificationException
- リマッピング機能がこのマップを変更したことが検出された場合
-
remove
キーのマッピングがあればTreeMapから削除します。- 定義:
- インタフェース
Map<K,V>
内のremove
- オーバーライド:
- クラス
AbstractMap<K,V>
のremove
- パラメータ:
key
- マッピングを削除する必要があるキー- 戻り値:
key
に以前に関連付けられていた値。key
のマッピングが存在しなかった場合はnull
。 (戻り値null
は、マップが以前にnull
とkey
を関連付けていたことを示す場合もある)- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合
-
clear
public void clear()すべてのマッピングをマップから削除します。 この呼出しが戻ると、マップは空になります。 -
clone
public Object clone()TreeMap
のインスタンスのシャロー・コピーを返します。 そのキーと値は複製されません。- オーバーライド:
- クラス
AbstractMap<K,V>
のclone
- 戻り値:
- このマップのシャロー・コピー
- 関連項目:
Cloneable
-
firstEntry
インタフェースからコピーされた説明:NavigableMap
このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のfirstEntry
- 戻り値:
- 最小のキーを持つエントリ。このマップが空の場合は
null
- 導入されたバージョン:
- 1.6
-
lastEntry
インタフェースからコピーされた説明:NavigableMap
このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のlastEntry
- 戻り値:
- 最大のキーを持つエントリ。このマップが空の場合は
null
- 導入されたバージョン:
- 1.6
-
pollFirstEntry
インタフェースからコピーされた説明:NavigableMap
このマップ内の最小のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のpollFirstEntry
- 戻り値:
- このマップの削除された最初のエントリ。このマップが空の場合は
null
- 導入されたバージョン:
- 1.6
-
pollLastEntry
インタフェースからコピーされた説明:NavigableMap
このマップ内の最大のキーに関連付けられたキーと値のマッピングを削除し、返します。マップが空の場合、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のpollLastEntry
- 戻り値:
- このマップの削除された最後のエントリ。このマップが空の場合は
null
- 導入されたバージョン:
- 1.6
-
lowerEntry
インタフェースからコピーされた説明:NavigableMap
指定されたキーよりも確実に小さい、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のlowerEntry
- パラメータ:
key
- キー- 戻り値:
key
よりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
lowerKey
インタフェースからコピーされた説明:NavigableMap
指定されたキーよりも確実に小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnull
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のlowerKey
- パラメータ:
key
- キー- 戻り値:
key
よりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
floorEntry
インタフェースからコピーされた説明:NavigableMap
指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のfloorEntry
- パラメータ:
key
- キー- 戻り値:
key
と等しいか、それよりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
floorKey
インタフェースからコピーされた説明:NavigableMap
指定されたキーと等しいかそれよりも小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnull
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のfloorKey
- パラメータ:
key
- キー- 戻り値:
key
と等しいか、それよりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
ceilingEntry
インタフェースからコピーされた説明:NavigableMap
指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のceilingEntry
- パラメータ:
key
- キー- 戻り値:
key
と等しいか、それよりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
ceilingKey
インタフェースからコピーされた説明:NavigableMap
指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnull
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のceilingKey
- パラメータ:
key
- キー- 戻り値:
key
と等しいか、それよりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
higherEntry
インタフェースからコピーされた説明:NavigableMap
指定されたキーよりも確実に大きい、最小のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、null
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のhigherEntry
- パラメータ:
key
- キー- 戻り値:
key
よりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
higherKey
インタフェースからコピーされた説明:NavigableMap
指定されたキーよりも確実に大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnull
を返します。- 定義:
- インタフェース
NavigableMap<K,V>
内のhigherKey
- パラメータ:
key
- キー- 戻り値:
key
よりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnull
- 例外:
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合- 導入されたバージョン:
- 1.6
-
keySet
このマップに含まれるキーのSet
ビューを返します。セットのイテレータは、キーを昇順で返します。 セットのスプリッテレータは遅延バインディングかつフェイルファストであり、さらに
Spliterator.SORTED
およびSpliterator.ORDERED
(キーの昇順である検出順序で)を報告します。 ツリー・マップのコンパレータ(comparator()
を参照)がnull
である場合、スプリッテレータのコンパレータ(Spliterator.getComparator()
を参照)はnull
です。 それ以外の場合、スプリッテレータのコンパレータはツリー・マップのコンパレータと同じであるか、同じ全体順序付けを義務付けます。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身の
remove
オペレーションを除く)。 セットは要素の削除をサポートします。Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションで対応するマッピングをマップから削除します。add
またはaddAll
操作はサポートされていません。 -
descendingKeySet
public NavigableSet<K> descendingKeySet()インタフェースからコピーされた説明:NavigableMap
このマップに含まれるキーの逆順のNavigableSet
ビューを返します。 セットのイテレータは、キーを降順で返します。 セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremove
操作を除く)。 セットは要素の削除をサポートします。Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションで対応するマッピングをマップから削除します。add
またはaddAll
操作はサポートされていません。- 定義:
- インタフェース
NavigableMap<K,V>
内のdescendingKeySet
- 戻り値:
- このマップ内のキーのナビゲート可能な逆順セット・ビュー
- 導入されたバージョン:
- 1.6
-
values
public Collection<V> values()このマップに含まれる値のCollection
ビューを返します。コレクションのイテレータは、値を対応するキーの昇順で返します。 コレクションのスプリッテレータは遅延バインディングかつフェイルファストであり、さらに
Spliterator.ORDERED
(対応するキーの昇順である検出順序で)を報告します。コレクションはマップと連動しているので、マップに対する変更はコレクションに反映され、またコレクションに対する変更はマップに反映されます。 コレクションの反復処理中にマップが変更された場合、反復処理の結果は定義されません(イテレータ自身の
remove
オペレーションを除く)。 コレクションは要素の削除をサポートしており、対応するマッピングをマップから削除できます。削除は、Iterator.remove
、Collection.remove
、removeAll
、retainAll
、およびclear
オペレーションを通して行います。add
またはaddAll
操作はサポートされていません。 -
entrySet
このマップに含まれるマッピングのSet
ビューを返します。セットのイテレータは、エントリをキーの昇順で返します。 セットのスプリッテレータは遅延バインディングかつフェイルファストであり、さらに
Spliterator.SORTED
およびSpliterator.ORDERED
(キーの昇順である検出順序で)を報告します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットの反復処理中にマップが変更された場合、反復処理の結果は定義されません(イテレータ自身の
remove
オペレーション、またはイテレータにより返されるマップ・エントリに対するsetValue
オペレーションを除く)。 セットは要素の削除をサポートしており、対応するマッピングをマップから削除できます。削除は、Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションを通して行います。add
またはaddAll
操作はサポートされていません。 -
descendingMap
public NavigableMap<K,V> descendingMap()インタフェースからコピーされた説明:NavigableMap
このマップ内に保持されているマッピングの逆順のビューを返します。 降順マップはこのマップに連動しており、このマップでの変更は降順マップに反映され、その逆の場合も同様です。 いずれかのマップのコレクション・ビューの反復処理中にいずれかのマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremove
オペレーションを除く)。返されるマップの順序付けは、
Collections.reverseOrder
(comparator())
と同等になります。 式m.descendingMap().descendingMap()
から返されるm
のビューは基本的にm
と同等になります。- 定義:
- インタフェース
NavigableMap<K,V>
内のdescendingMap
- 戻り値:
- このマップの逆順のビュー
- 導入されたバージョン:
- 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
をスローします。- 定義:
- インタフェース
NavigableMap<K,V>
内のsubMap
- パラメータ:
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
をスローします。- 定義:
- インタフェース
NavigableMap<K,V>
内のheadMap
- パラメータ:
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
をスローします。- 定義:
- インタフェース
NavigableMap<K,V>
内のtailMap
- パラメータ:
fromKey
- 返されるマップ内のキーの下端点inclusive
- 返されるビューに下端点が含まれる場合はtrue
- 戻り値:
- このマップの
fromKey
よりも大きいキー(inclusive
がtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビュー - 例外:
ClassCastException
-fromKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKey
がComparable
を実装していない場合)。 実装は、マップ内に現在存在しているキーとfromKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
-fromKey
がnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、fromKey
がその範囲から外れている場合- 導入されたバージョン:
- 1.6
-
subMap
インタフェースからコピーされた説明:NavigableMap
このマップのfromKey
(これを含む) -toKey
(これを含まない)のキー範囲を持つ部分のビューを返します。fromKey
とtoKey
が等しい場合は、空のマップが返されます。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。返されるマップは、その範囲外のキーが挿入されようとすると、
IllegalArgumentException
をスローします。subMap(fromKey, true, toKey, false)
と同等です。- 定義:
- インタフェース
NavigableMap<K,V>
内のsubMap
- 定義:
- インタフェース
SortedMap<K,V>
内のsubMap
- パラメータ:
fromKey
- 返されるマップ内のキーの下端点(これを含む)toKey
- 返されるマップ内のキーの上端点(これを含まない)- 戻り値:
- このマップの
fromKey
(これを含む)からtoKey
(これを含まない)のキー範囲を持つ部分のビュー - 例外:
ClassCastException
- このマップのコンパレータを使用して(このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKey
とtoKey
を相互に比較できない場合。 実装は、マップ内に現在存在しているキーとfromKey
またはtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではない。NullPointerException
-fromKey
またはtoKey
がnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合IllegalArgumentException
-fromKey
がtoKey
よりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKey
またはtoKey
がその範囲から外れている場合
-
headMap
インタフェースからコピーされた説明:NavigableMap
このマップのtoKey
よりも確実に小さいキーを持つ部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。返されるマップは、その範囲外のキーが挿入されようとすると、
IllegalArgumentException
をスローします。headMap(toKey, false)
と同等です。- 定義:
- インタフェース
NavigableMap<K,V>
内のheadMap
- 定義:
- インタフェース
SortedMap<K,V>
内のheadMap
- パラメータ:
toKey
- 返されるマップ内のキーの上端点(これを含まない)- 戻り値:
- このマップの
toKey
よりも確実に小さいキーを持つ部分のビュー - 例外:
ClassCastException
-toKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、toKey
がComparable
を実装していない場合)。 実装は、マップ内に現在存在しているキーとtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
-toKey
がnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、toKey
がその範囲から外れている場合
-
tailMap
インタフェースからコピーされた説明:NavigableMap
このマップのfromKey
以上のキーを持つ部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。返されるマップは、その範囲外のキーが挿入されようとすると、
IllegalArgumentException
をスローします。tailMap(fromKey, true)
と同等です。- 定義:
- インタフェース
NavigableMap<K,V>
内のtailMap
- 定義:
- インタフェース
SortedMap<K,V>
内のtailMap
- パラメータ:
fromKey
- 返されるマップ内のキーの下端点(これを含む)- 戻り値:
- このマップの
fromKey
以上のキーを持つ部分のビュー - 例外:
ClassCastException
-fromKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKey
がComparable
を実装していない場合)。 実装は、マップ内に現在存在しているキーとfromKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
-fromKey
がnullであり、このマップが自然順序付けを使用しているかそのコンパレータがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、fromKey
がその範囲から外れている場合
-