@GwtCompatible public abstract class ForwardingSortedMap<K,V> extends ForwardingMap<K,V> implements SortedMap<K,V>
Warning: The methods of ForwardingSortedMap forward indiscriminately to
the methods of the delegate. For example, overriding ForwardingMap.put(K, V) alone will not change
the behavior of ForwardingMap.putAll(java.util.Map<? extends K, ? extends V>), which can lead to unexpected behavior. In this case, you should
override putAll as well, either providing your own implementation, or delegating to the
provided standardPutAll method.
default method warning: This class does not forward calls to default methods. Instead, it inherits their default implementations. When those implementations
invoke methods, they invoke methods on the ForwardingSortedMap.
Each of the standard methods, where appropriate, use the comparator of the map to test
equality for both keys and values, unlike ForwardingMap.
The standard methods and the collection views they return are not guaranteed to be
thread-safe, even when all of the methods that they depend on are thread-safe.
| Modifier and Type | Class and Description |
|---|---|
protected class |
ForwardingSortedMap.StandardKeySet
A sensible implementation of
SortedMap.keySet() in terms of the methods of ForwardingSortedMap. |
ForwardingMap.StandardEntrySet, ForwardingMap.StandardValues| Modifier | Constructor and Description |
|---|---|
protected |
ForwardingSortedMap()
Constructor for use by subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
Comparator<? super K> |
comparator()
Returns the comparator used to order the keys in this map, or
null if this map uses the natural ordering of its keys. |
protected abstract SortedMap<K,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
K |
firstKey()
Returns the first (lowest) key currently in this map.
|
SortedMap<K,V> |
headMap(K toKey)
Returns a view of the portion of this map whose keys are
strictly less than
toKey. |
K |
lastKey()
Returns the last (highest) key currently in this map.
|
protected boolean |
standardContainsKey(Object key)
A sensible definition of
ForwardingMap.containsKey(java.lang.Object) in terms of the firstKey() method of
tailMap(K). |
protected SortedMap<K,V> |
standardSubMap(K fromKey,
K toKey)
A sensible default implementation of
subMap(Object, Object) in terms of headMap(Object) and tailMap(Object). |
SortedMap<K,V> |
subMap(K fromKey,
K toKey)
Returns a view of the portion of this map whose keys range from
fromKey, inclusive, to toKey, exclusive. |
SortedMap<K,V> |
tailMap(K fromKey)
Returns a view of the portion of this map whose keys are
greater than or equal to
fromKey. |
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, standardClear, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString, valuestoStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, sizeprotected ForwardingSortedMap()
protected abstract SortedMap<K,V> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply the
instance being decorated.delegate in class ForwardingMap<K,V>public Comparator<? super K> comparator()
java.util.SortedMapnull if this map uses the natural ordering of its keys.comparator in interface SortedMap<K,V>null if this map uses the natural ordering
of its keyspublic K firstKey()
java.util.SortedMappublic SortedMap<K,V> headMap(K toKey)
java.util.SortedMaptoKey. The returned map is backed
by this map, so changes in the returned map are reflected in
this map, and vice-versa. The returned map supports all
optional map operations that this map supports.
The returned map will throw an IllegalArgumentException
on an attempt to insert a key outside its range.
public K lastKey()
java.util.SortedMappublic SortedMap<K,V> subMap(K fromKey, K toKey)
java.util.SortedMapfromKey, inclusive, to toKey, exclusive. (If
fromKey and toKey are equal, the returned map
is empty.) The returned map is backed by this map, so changes
in the returned map are reflected in this map, and vice-versa.
The returned map supports all optional map operations that this
map supports.
The returned map will throw an IllegalArgumentException
on an attempt to insert a key outside its range.
public SortedMap<K,V> tailMap(K fromKey)
java.util.SortedMapfromKey. The returned map is
backed by this map, so changes in the returned map are
reflected in this map, and vice-versa. The returned map
supports all optional map operations that this map supports.
The returned map will throw an IllegalArgumentException
on an attempt to insert a key outside its range.
@Beta protected boolean standardContainsKey(@NullableDecl Object key)
ForwardingMap.containsKey(java.lang.Object) in terms of the firstKey() method of
tailMap(K). If you override tailMap(K), you may wish to override ForwardingMap.containsKey(java.lang.Object) to forward to this implementation.standardContainsKey in class ForwardingMap<K,V>@Beta protected SortedMap<K,V> standardSubMap(K fromKey, K toKey)
subMap(Object, Object) in terms of headMap(Object) and tailMap(Object). In some situations, you may wish to override
subMap(Object, Object) to forward to this implementation.Copyright © 2010–2018. All rights reserved.