K
- このマップで保持されるキーの型V
- マップされる値の型public interface NavigableMap<K,V> extends SortedMap<K,V>
SortedMap
です。lowerEntry
、floorEntry
、ceilingEntry
、higherEntry
メソッドはそれぞれ、指定されたキーよりも小さいキー、小さいか等しいキー、大きいか等しいキー、大きいキーに関連付けられたMap.Entry
オブジェクトを返します。ただし、そのようなキーが存在しない場合はnull
を返します。同様に、lowerKey
、floorKey
、ceilingKey
、およびhigherKey
メソッドは、関連するキーのみを返します。これらのすべてのメソッドの設計目的は、エントリをトラバースすることではなく、エントリを特定することです。
NavigableMap
へのアクセスやトラバースは、キーの昇順、降順のいずれかで行えます。descendingMap
メソッドから返されるこのマップのビューでは、関係や方向に関するメソッドがすべて反転されたかのように感じられます。オペレーションやビューのパフォーマンスは通常、降順よりも昇順のほうが高速になります。subMap
、headMap
、およびtailMap
メソッドは、下限と上限を含めるかどうかを記述する追加の引数を受け取るという点で、SortedMap
の類似の名前を持つメソッドとは異なります。どのNavigableMap
のサブマップでもNavigableMap
インタフェースを実装する必要があります。
このインタフェースにはさらに、firstEntry
、pollFirstEntry
、lastEntry
、およびpollLastEntry
メソッドも定義されています。これらのメソッドは、最小、最大のマッピングが存在する場合はそのリターンまたは削除、あるいはその両方を行い、それ以外の場合はnull
を返します。
エントリを返すメソッドの実装は、マッピングの生成時点でのスナップショットを表すMap.Entry
ペアを返すことを期待されるため、オプションのEntry.setValue
メソッドを通常はサポートしません。ただし、関連するマップ内のマッピングはput
メソッドを使って変更できます。
subMap(K, K)
、headMap(K)
およびtailMap(K)
メソッドは、既存のSortedMap
実装を互換的に改良してNavigableMap
を実装できるようにするために、SortedMap
を返すように規定されています。ただし、このインタフェースの拡張および実装は、これらのメソッドをオーバーライドしてNavigableMap
を返すようにすることをお薦めします。同様に、SortedMap.keySet()
をオーバーライドしてNavigableSet
を返すようにすることもできます。
このインタフェースは、Java Collections Frameworkのメンバーです。
修飾子と型 | メソッドと説明 |
---|---|
Map.Entry<K,V> |
ceilingEntry(K key)
指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、
null を返します。 |
K |
ceilingKey(K key)
指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合は
null を返します。 |
NavigableSet<K> |
descendingKeySet()
このマップに含まれるキーの逆順の
NavigableSet ビューを返します。 |
NavigableMap<K,V> |
descendingMap()
このマップ内に保持されているマッピングの逆順のビューを返します。
|
Map.Entry<K,V> |
firstEntry()
このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、
null を返します。 |
Map.Entry<K,V> |
floorEntry(K key)
指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、
null を返します。 |
K |
floorKey(K 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 を返します。 |
Map.Entry<K,V> |
lastEntry()
このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、
null を返します。 |
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 を返します。 |
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の場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。 |
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
Map.Entry<K,V> lowerEntry(K key)
null
を返します。key
- キーkey
よりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合K lowerKey(K key)
null
を返します。key
- キーkey
よりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> floorEntry(K key)
null
を返します。key
- キーkey
と等しいか、それよりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合K floorKey(K key)
null
を返します。key
- キーkey
と等しいか、それよりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> ceilingEntry(K key)
null
を返します。key
- キーkey
と等しいか、それよりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合K ceilingKey(K key)
null
を返します。key
- キーkey
と等しいか、それよりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> higherEntry(K key)
null
を返します。key
- キーkey
よりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合K higherKey(K key)
null
を返します。key
- キーkey
よりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnull
ClassCastException
- 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException
- 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> firstEntry()
null
を返します。null
Map.Entry<K,V> lastEntry()
null
を返します。null
Map.Entry<K,V> pollFirstEntry()
null
を返します。null
Map.Entry<K,V> pollLastEntry()
null
を返します。null
NavigableMap<K,V> descendingMap()
remove
オペレーションを除く)。
返されるマップの順序付けは、Collections.reverseOrder
(comparator())と同等になります。式m.descendingMap().descendingMap()
から返されるm
のビューは基本的にm
と同等になります。
NavigableSet<K> navigableKeySet()
NavigableSet
ビューを返します。セットのイテレータは、キーを昇順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremove
オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションで対応するマッピングをマップから削除します。add
またはaddAll
オペレーションはサポートされていません。NavigableSet<K> descendingKeySet()
NavigableSet
ビューを返します。セットのイテレータは、キーを降順で返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremove
オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove
、Set.remove
、removeAll
、retainAll
、およびclear
オペレーションで対応するマッピングをマップから削除します。add
またはaddAll
オペレーションはサポートされていません。NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
fromKey
- toKey
のキー範囲を持つ部分のビューを返します。fromKey
とtoKey
が等しい場合、返されるマップは、fromInclusive
とtoInclusive
の両方がtrueでないかぎり、空になります。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとしたり、端点のいずれかがその範囲外にあるようなサブマップが構築されようとしたりすると、IllegalArgumentException
をスローします。
fromKey
- 返されるマップ内のキーの下端点fromInclusive
- 返されるビューに下端点が含まれる場合はtrue
toKey
- 返されるマップ内のキーの上端点toInclusive
- 返されるビューに上端点が含まれる場合はtrue
fromKey
- toKey
のキー範囲を持つ部分のビューClassCastException
- このマップのコンパレータを使用して(このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKey
とtoKey
を相互に比較できない場合。実装は、マップ内に現在存在しているキーとfromKey
またはtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではない。NullPointerException
- fromKey
またはtoKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- fromKey
がtoKey
よりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKey
またはtoKey
がその範囲から外れている場合NavigableMap<K,V> headMap(K toKey, boolean inclusive)
toKey
よりも小さいキー(inclusive
がtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException
をスローします。
toKey
- 返されるマップ内のキーの上端点inclusive
- 返されるビューに上端点が含まれる場合はtrue
toKey
よりも小さいキー(inclusive
がtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビューClassCastException
- toKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、toKey
がComparable
を実装していない場合)。実装は、マップ内に現在存在しているキーとtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
- toKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、toKey
がその範囲から外れている場合NavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
fromKey
よりも大きいキー(inclusive
がtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException
をスローします。
fromKey
- 返されるマップ内のキーの下端点inclusive
- 返されるビューに下端点が含まれる場合はtrue
fromKey
よりも大きいキー(inclusive
がtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビューClassCastException
- fromKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKey
がComparable
を実装していない場合)。実装は、マップ内に現在存在しているキーとfromKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
- fromKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、fromKey
がその範囲から外れている場合SortedMap<K,V> subMap(K fromKey, K toKey)
fromKey
(これを含む) - toKey
(これを含まない)のキー範囲を持つ部分のビューを返します。fromKey
とtoKey
が等しい場合は、空のマップが返されます。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException
をスローします。
subMap(fromKey, true, toKey, false)
と同等です。
subMap
、インタフェース: SortedMap<K,V>
fromKey
- 返されるマップ内のキーの下端点(これを含む)toKey
- 返されるマップ内のキーの上端点(これを含まない)fromKey
(これを含む)からtoKey
(これを含まない)のキー範囲を持つ部分のビューClassCastException
- このマップのコンパレータを使用して(このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKey
とtoKey
を相互に比較できない場合。実装は、マップ内に現在存在しているキーとfromKey
またはtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではない。NullPointerException
- fromKey
またはtoKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- fromKey
がtoKey
よりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKey
またはtoKey
がその範囲から外れている場合SortedMap<K,V> headMap(K toKey)
toKey
よりも確実に小さいキーを持つ部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException
をスローします。
headMap(toKey, false)
と同等です。
headMap
、インタフェース: SortedMap<K,V>
toKey
- 返されるマップ内のキーの上端点(これを含まない)toKey
よりも確実に小さいキーを持つ部分のビューClassCastException
- toKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、toKey
がComparable
を実装していない場合)。実装は、マップ内に現在存在しているキーとtoKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
- toKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、toKey
がその範囲から外れている場合SortedMap<K,V> tailMap(K fromKey)
fromKey
以上のキーを持つ部分のビューを返します。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。
返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentException
をスローします。
tailMap(fromKey, true)
と同等です。
tailMap
、インタフェース: SortedMap<K,V>
fromKey
- 返されるマップ内のキーの下端点(これを含む)fromKey
以上のキーを持つ部分のビューClassCastException
- fromKey
がこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKey
がComparable
を実装していない場合)。実装は、マップ内に現在存在しているキーとfromKey
とを比較できない場合にこの例外をスローできる。ただし、必須ではないNullPointerException
- fromKey
がnullであり、このマップがnullキーを許可しない場合IllegalArgumentException
- このマップ自体が制限された範囲を持っており、fromKey
がその範囲から外れている場合 バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.