基于源码的Java集合框架学习⑫ SortedMap接口

接口 SortedMap<K,V>

保证按照键的升序排列的映射，可以按照键的自然顺序（参见 Comparable 接口）进行排序，或者通过创建有序映射时提供的比较器进行排序。对有序映射的集合视图（由 entrySet、keySet 和 values 方法返回）进行迭代时，此顺序就会反映出来。要采用此排序，还需要提供一些其他操作（此接口是相似于 SortedSet 接口的映射）。

插入有序映射的所有键都必须实现 Comparable 接口（或者被指定的比较器所接受）。另外，所有这些键都必须是可互相比较的：k1.compareTo(k2)（或 comparator.compare(k1, k2)）对有序映射中的任意两个元素 k1 和 k2 都不得抛出 ClassCastException。试图违反这些限制将导致违反方法或者构造方法的调用，从而抛出 ClassCastException。

注意，如果有序映射正确实现了 Map 接口，则有序映射所保持的顺序（无论是否明确提供了比较器）都必须保持相等一致性。（相等一致性 的精确定义请参阅 Comparable 接口或 Comparator 接口）。这也是因为 Map 接口是按照 equals 操作定义的，但有序映射使用它的 compareTo（或 compare）方法对所有键进行比较，因此从有序映射的观点来看，此方法认为相等的两个键就是相等的。即使顺序没有保持相等一致性，树映射的行为仍然是 定义良好的，只不过没有遵守 Map 接口的常规协定。

所有通用有序映射实现类都应该提供 4 个“标准”构造方法：1) void（不带参数）构造方法，创建空的有序映射，按照键的自然顺序 排序。2) 带有一个 Comparator 类型参数的构造方法，创建一个空的有序映射，根据指定的比较器排序。3) 带有一个 Map 类型参数的构造方法，创建一个键-值映射关系与参数相同的有序映射，按照键的自然顺序排序。4) 带有一个有序映射类型参数的构造方法，创建一个新的有序映射，键-值映射关系及排序方法与输入的有序映射相同。除了 JDK 实现（TreeMap 类）遵循此建议外，无法保证强制实施此建议（因为接口不能包含构造方法）。

方法

Comparator<? super K> comparator() 
返回与此有序映射关联的比较器，如果使用键的自然顺序，则返回 null。 
K firstKey() 
返回有序映射中当前第一个（最小的）键。 
SortedMap<K,V> headMap(K toKey) 
返回此有序映射的部分视图，其键值严格小于 toKey。 
K lastKey() 
返回有序映射中当前最后一个（最大的）键。 
SortedMap<K,V> subMap(K fromKey, K toKey) 
返回此有序映射的部分视图，其键值从 fromKey（包括）到 toKey（不包括）。 
SortedMap<K,V> tailMap(K fromKey) 
返回有序映射的部分视图，其键大于或等于 fromKey。 

接口 NavigableMap<K,V>

NavigableMap扩展了 SortedMap，具有了针对给定搜索目标返回最接近匹配项的导航方法。方法 lowerEntry、floorEntry、ceilingEntry 和 higherEntry 分别返回与小于、小于等于、大于等于、大于给定键的键关联的 Map.Entry 对象，如果不存在这样的键，则返回 null。类似地，方法 lowerKey、floorKey、ceilingKey 和 higherKey 只返回关联的键。所有这些方法是为查找条目而不是遍历条目而设计的。

可以按照键的升序或降序访问和遍历 NavigableMap。descendingMap 方法返回映射的一个视图，该视图表示的所有关系方法和方向方法都是逆向的。升序操作和视图的性能很可能比降序操作和视图的性能要好。subMap、headMap 和 tailMap 方法与名称相似的 SortedMap 方法的不同之处在于：可以接受用于描述是否包括（或不包括）下边界和上边界的附加参数。任何 NavigableMap 的 Submap 必须实现 NavigableMap 接口。

此接口还定义了 firstEntry、pollFirstEntry、lastEntry 和 pollLastEntry 方法，它们返回和/或移除最小和最大的映射关系（如果存在），否则返回 null。

subMap(K, K)、headMap(K) 和 tailMap(K) 方法被指定为返回 SortedMap，以允许现有 SortedMap 实现能相容地改进为实现 NavigableMap，但鼓励此接口的扩展和实现重写这些方法以返回 NavigableMap。类似地，可以重写 SortedMap.keySet() 以返回 NavigableSet。

方法

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) 
返回此映射的部分视图，其键小于（或等于，如果 inclusive 为 true）toKey。

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) 
返回此映射的部分视图，其键大于（或等于，如果 inclusive 为 true）fromKey。