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, sizeMap.Entry<K,V> lowerEntry(K key)
nullを返します。key - キーkeyよりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合K lowerKey(K key)
nullを返します。key - キーkeyよりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> floorEntry(K key)
nullを返します。key - キーkeyと等しいか、それよりも小さいキーの中で最大のものを持つエントリ。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合K floorKey(K key)
nullを返します。key - キーkeyと等しいか、それよりも小さいキーの中で最大のもの。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> ceilingEntry(K key)
nullを返します。key - キーkeyと等しいか、それよりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合K ceilingKey(K key)
nullを返します。key - キーkeyと等しいか、それよりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> higherEntry(K key)
nullを返します。key - キーkeyよりも大きいキーの中で最小のものを持つエントリ。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合K higherKey(K key)
nullを返します。key - キーkeyよりも大きいキーの中で最小のもの。そのようなキーが存在しない場合はnullClassCastException - 指定されたキーがマップ内に現在あるキーと比較できない場合NullPointerException - 指定されたキーがnullであり、このマップがnullキーを許可しない場合Map.Entry<K,V> firstEntry()
nullを返します。nullMap.Entry<K,V> lastEntry()
nullを返します。nullMap.Entry<K,V> pollFirstEntry()
nullを返します。nullMap.Entry<K,V> pollLastEntry()
nullを返します。nullNavigableMap<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 - 返されるビューに下端点が含まれる場合はtruetoKey - 返されるマップ内のキーの上端点toInclusive - 返されるビューに上端点が含まれる場合はtruefromKey - 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 - 返されるビューに上端点が含まれる場合はtruetoKeyよりも小さいキー(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 - 返されるビューに下端点が含まれる場合はtruefromKeyよりも大きいキー(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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Documentation Redistribution Policyも参照してください。