compact1, compact2, compact3

java.util

Interface NavigableMap<K,V>

参数类型

K -钥匙的Map保持型

V -映射的值的类型

All Superinterfaces:

Map < k，v >， SortedMap < k，v >

All Known Subinterfaces:

ConcurrentNavigableMap < k，v >

所有已知实现类：

ConcurrentSkipListMap， TreeMap

public interface NavigableMap<K,V>
extends SortedMap<K,V>

扩展的导航方法返回最接近的匹配给定的搜索目标 SortedMap。方法 lowerEntry， floorEntry， ceilingEntry，和 higherEntry返回 Map.Entry对象键分别小于，小于或等于、大于或等于、大于给定的键，返回 null如果没有这样的关键。同样，方法 lowerKey， floorKey， ceilingKey，和 higherKey只返回键值。所有这些方法都是为定位而设计的，而不是遍历条目。

一个NavigableMap可以访问和遍历升序或降序键顺序。的descendingMap方法返回一个视图的所有关联方法倒和定向感官Map。提升操作和视图的性能可能会比下降的速度更快。方法subMap，headMap，和tailMap不同于像在接受额外的参数描述是否上下界的包容性与排他性的命名SortedMap方法。任何NavigableMap子图必须实现NavigableMap接口。

这个接口定义的方法firstEntry另外，pollFirstEntry，lastEntry，和pollLastEntry返回和/或去除最大和最小的映射，如果存在的话，别人还null。

进入回归方法实现预期收益Map.Entry对代表快照映射在当时产生的，因而一般不支持可选的Entry.setValue方法。但是注意，它有可能在相关的Map使用方法put变化映射。

方法subMap(K, K)，headMap(K)，和tailMap(K)指定返回SortedMap允许SortedMap现有实现是兼容改造的实施NavigableMap，但扩展和实现该接口被鼓励重写这些方法返回NavigableMap。同样，SortedMap.keySet()可以修改返回NavigableSet。

该接口的 Java Collections Framework成员。

从以下版本开始：

一点六

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

方法摘要

Modifier and Type	Method and Description
Map.Entry<K,V>	ceilingEntry(K key) 返回的键值映射与最关键的大于或等于给定的键，或 null如果没有这样的关键。
K	ceilingKey(K key) 最关键的收益大于或等于给定的键，或 null如果没有这样的关键。
NavigableSet<K>	descendingKeySet() 返回一个相反的顺序 NavigableSet查看键包含在这个Map。
NavigableMap<K,V>	descendingMap() 返回此映射中包含的映射的逆顺序视图。
Map.Entry<K,V>	firstEntry() 返回一个与该图的最小密钥相关的键值映射，或 null如果Map是空的。
Map.Entry<K,V>	floorEntry(K key) 返回的键值映射与最大的小于或等于给定的键，或 null如果没有这样的关键。
K	floorKey(K key) 返回最大关键小于或等于给定的键，或 null如果没有这样的关键。
SortedMap<K,V>	headMap(K toKey) 返回从这个Map的关键是严格小于 toKey部分。
NavigableMap<K,V>	headMap(K toKey, boolean inclusive) 返回从这个Map的关键是少部分（或相等，如果 inclusive是真的） toKey。
Map.Entry<K,V>	higherEntry(K key) 返回的键值映射与最关键严格大于给定的键，或 null如果没有这样的关键。
K	higherKey(K key) 返回最关键严格大于给定的键，或 null如果没有这样的关键。
Map.Entry<K,V>	lastEntry() 返回一个与该Map的最大密钥相关的键值映射，或 null如果Map是空的。
Map.Entry<K,V>	lowerEntry(K key) 返回的键值映射与最大的关键严格小于给定的键，或 null如果没有这样的关键。
K	lowerKey(K key) 返回最大关键严格小于给定的键，或 null如果没有这样的关键。
NavigableSet<K>	navigableKeySet() 返回一个 NavigableSet查看键包含在这个Map。
Map.Entry<K,V>	pollFirstEntry() 删除并返回一个与该图的最小密钥相关的键值映射，或 null如果Map是空的。
Map.Entry<K,V>	pollLastEntry() 删除并返回一个与该Map的最大密钥相关的键值映射，或 null如果Map是空的。
NavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive) 返回从这个Map的键范围从 fromKey到 toKey部分。
SortedMap<K,V>	subMap(K fromKey, K toKey) 返回从这个Map的键范围从 fromKey，包容的部分 toKey，独家。
SortedMap<K,V>	tailMap(K fromKey) 返回从这个Map的关键是大于或等于 fromKey部分。
NavigableMap<K,V>	tailMap(K fromKey, boolean inclusive) 返回从这个Map的关键是大于（或等于部分，如果 inclusive是真的） fromKey。

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, values

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

方法详细信息

lowerEntry

Map.Entry<K,V> lowerEntry(K key)

返回的键值映射与最大的关键严格小于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

一个最大的不足 key入境，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

lowerKey

K lowerKey(K key)

返回最大关键严格小于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

最大的不足 key，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

floorEntry

Map.Entry<K,V> floorEntry(K key)

返回的键值映射与最大的小于或等于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

一个最关键的小于或等于 key入境，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

floorKey

K floorKey(K key)

返回最大关键小于或等于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

最关键的是小于或等于 key，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

ceilingEntry

Map.Entry<K,V> ceilingEntry(K key)

返回的键值映射与最关键的大于或等于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

一个大于或等于 key最关键的条目，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

ceilingKey

K ceilingKey(K key)

最关键的收益大于或等于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

大于或等于 key最关键，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

higherEntry

Map.Entry<K,V> higherEntry(K key)

返回的键值映射与最关键严格大于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

一个大于 key最关键的条目，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

higherKey

K higherKey(K key)

返回最关键严格大于给定的键，或 null如果没有这样的关键。

参数

key的关键

结果

大于 key最关键，或 null如果没有这样的关键

异常

ClassCastException -如果指定的键不能与目前在Map的按键相比

NullPointerException -如果指定的键是无效的，这张Map不允许null键

firstEntry

Map.Entry<K,V> firstEntry()

返回一个与该图的最小密钥相关的键值映射，或 null如果Map是空的。

结果

一个用最少的按键输入，或 null如果这个Map是空的

lastEntry

Map.Entry<K,V> lastEntry()

返回一个与该Map的最大密钥相关的键值映射，或 null如果Map是空的。

结果

一个最关键的条目，或 null如果这个Map是空的

pollFirstEntry

Map.Entry<K,V> pollFirstEntry()

删除并返回一个与该图的最小密钥相关的键值映射，或 null如果Map是空的。

结果

被删除的第一次进入这个Map，或 null如果这个Map是空的

pollLastEntry

Map.Entry<K,V> pollLastEntry()

删除并返回一个与该Map的最大密钥相关的键值映射，或 null如果Map是空的。

结果

删除这个Map上的入口，或 null如果这个Map是空的

descendingMap

NavigableMap<K,V> descendingMap()

返回此映射中包含的映射的逆顺序视图。该Map是由这张Map的支持，所以对Map的变化反映在Map上，反之亦然。如果Map是在一个Map的集合视图的迭代过程中修改（除非通过迭代器的 remove操作），迭代的结果是不确定的。

返回Map具有订购相当于Collections.reverseOrder(comparator())。表达m.descendingMap().descendingMap()返回从m本质上相当于m。

结果

这张Map的一个相反的顺序视图

navigableKeySet

NavigableSet<K> navigableKeySet()

返回一个 NavigableSet的关键视图包含在这个Map。该集合的迭代器以提升顺序返回键。该集合是由Map的支持，所以对Map的变化反映在集合中，反之亦然。如果Map是在设置一个迭代过程中修改（除非通过迭代器的 remove操作），迭代的结果是不确定的。设置支持元素的去除，从Map中移除相应的映射，通过 Iterator.remove， Set.remove， removeAll， retainAll，和 clear操作。它不支持 add或 addAll操作。

结果

在这张Map上的键的可导航的集合视图

descendingKeySet

NavigableSet<K> descendingKeySet()

返回一个相反的顺序 NavigableSet查看键包含在这个Map。该集合的迭代器以递减的顺序返回键。该集合是由Map的支持，所以对Map的变化反映在集合中，反之亦然。如果Map是在设置一个迭代过程中修改（除非通过迭代器的 remove操作），迭代的结果是不确定的。设置支持元素的去除，从Map中移除相应的映射，通过 Iterator.remove， Set.remove， removeAll， retainAll，和 clear操作。它不支持 add或 addAll操作。

结果

在这张Map中的键的一个反向顺序可导航的集合视图

subMap

NavigableMap<K,V> subMap(K fromKey,
                         boolean fromInclusive,
                         K toKey,
                         boolean toInclusive)

返回从这个Map的键范围从 fromKey到 toKey部分。如果 fromKey和 toKey相等，返回Map是空的，除非 fromInclusive toInclusive都是真实的。返回的Map是由这张Map的支持，所以在返回的Map的变化反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在它的范围之外的一个IllegalArgumentException，或构建一个区块是其端点超出其范围。

参数

fromKey -返回Map的关键端点低

fromInclusive - true如果低的终点是被包含在返回的视图

toKey -返回Map的关键点

toInclusive - true如果高终点是被包含在返回的视图

结果

看这张Map的键范围从 fromKey到 toKey部分

异常

ClassCastException -如果 fromKey和 toKey不能与另一个使用这个Map的比较器（或者，如果Map没有比较器，采用自然排序）。实现可能，但不是必需的，如果 fromKey或 toKey不能相比，目前在Map键抛出该异常。

NullPointerException -如果 fromKey或 toKey是无效的，这张Map不允许null键

IllegalArgumentException -如果 fromKey大于 toKey；或者如果这Map本身有一个限制的范围内，和 fromKey或 toKey超出范围的界限

headMap

NavigableMap<K,V> headMap(K toKey,
                          boolean inclusive)

返回从这个Map的关键是少部分（或相等，如果 inclusive是真的） toKey。返回的Map由Map的支持，所以在返回的Map变化都反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在其范围内的IllegalArgumentException。

参数

toKey -返回Map的关键点

inclusive - true如果高终点是被包含在返回的视图

结果

看这张Map的关键是少部分（或相等，如果 inclusive是真的） toKey

异常

ClassCastException -如果 toKey不是这个Map的比较器兼容的（或者，如果Map没有比较，如果 toKey不实现 Comparable）。实现可能，但不是必需的，如果 toKey不能相比，目前在Map键抛出该异常。

如果 toKey NullPointerException是无效的，这张Map不允许null键

IllegalArgumentException -如果这Map本身有一个限制的范围内，和 toKey超出范围的界限

tailMap

NavigableMap<K,V> tailMap(K fromKey,
                          boolean inclusive)

返回从这个Map的关键是大于（或等于部分，如果 inclusive是真的） fromKey。返回的Map是由这张Map的支持，所以在返回的Map的变化反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在其范围内的IllegalArgumentException。

参数

fromKey -返回Map的关键端点低

inclusive - true如果低的终点是被包含在返回的视图

结果

看这张Map的关键是大于（或等于部分，如果 inclusive是真的） fromKey

异常

ClassCastException -如果 fromKey不是这个Map的比较器兼容的（或者，如果Map没有比较，如果 fromKey不实现 Comparable）。实现可能，但不是必需的，如果 fromKey不能相比，目前在Map键抛出该异常。

如果 fromKey NullPointerException是无效的，这张Map不允许null键

IllegalArgumentException -如果这Map本身有一个限制的范围内，和 fromKey超出范围的界限

subMap

SortedMap<K,V> subMap(K fromKey,
                      K toKey)

返回从这个Map的键范围从 fromKey，包容的部分 toKey，独家。（如果 fromKey和 toKey相等，返回Map是空的。）返回的Map由Map的支持，所以在返回的Map变化都反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在其范围内的IllegalArgumentException。

相当于subMap(fromKey, true, toKey, false)。

Specified by:

subMap 接口 SortedMap<K,V>

参数

fromKey低端点（含）返回的映射中的键

toKey高端点（独家）返回的映射中的键

结果

看这张Map的键范围从 fromKey，包容的部分 toKey，独家

异常

ClassCastException -如果 fromKey和 toKey不能与另一个使用这个Map的比较器（或者，如果Map没有比较器，采用自然排序）。实现可能，但不是必需的，如果 fromKey或 toKey不能相比，目前在Map键抛出该异常。

NullPointerException -如果 fromKey或 toKey是无效的，这张Map不允许null键

IllegalArgumentException -如果 fromKey大于 toKey；或者如果这Map本身有一个限制的范围内，和 fromKey或 toKey超出范围的界限

headMap

SortedMap<K,V> headMap(K toKey)

返回从这个Map的关键是严格小于 toKey部分。返回的Map是由这张Map的支持，所以在返回的Map的变化反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在其范围内的IllegalArgumentException。

相当于headMap(toKey, false)。

Specified by:

headMap 接口 SortedMap<K,V>

参数

toKey高端点（独家）返回的映射中的键

结果

看这张Map的关键是严格小于 toKey部分

异常

ClassCastException -如果 toKey不是这个Map的比较器兼容的（或者，如果Map没有比较，如果 toKey不实现 Comparable）。实现可能，但不是必需的，如果 toKey不能相比，目前在Map键抛出该异常。

如果 toKey NullPointerException是无效的，这张Map不允许null键

IllegalArgumentException -如果这Map本身有一个限制的范围内，和 toKey超出范围的界限

tailMap

SortedMap<K,V> tailMap(K fromKey)

返回从这个Map的关键是大于或等于 fromKey部分。返回的Map是由这张Map的支持，所以在返回的Map的变化反映在这张Map上，反之亦然。返回的Map支持这张Map支持的所有可选的Map操作。

返回的Map将把企图把钥匙插在其范围内的IllegalArgumentException。

相当于tailMap(fromKey, true)。

Specified by:

tailMap 接口 SortedMap<K,V>

参数

fromKey低端点（含）返回的映射中的键

结果

看这张Map的关键是大于或等于 fromKey部分

异常

ClassCastException -如果 fromKey不是这个Map的比较器兼容的（或者，如果Map没有比较，如果 fromKey不实现 Comparable）。实现可能，但不是必需的，如果 fromKey不能相比，目前在Map键抛出该异常。

如果 fromKey NullPointerException是无效的，这张Map不允许null键

IllegalArgumentException -如果这Map本身有一个限制的范围内，和 fromKey超出范围的界限