Class ForwardingSortedMap<K extends @Nullable Object,V extends @Nullable Object>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingMap<K,V>
-
- com.google.common.collect.ForwardingSortedMap<K,V>
-
- Direct Known Subclasses:
ForwardingNavigableMap
@GwtCompatible public abstract class ForwardingSortedMap<K extends @Nullable Object,V extends @Nullable Object> extends ForwardingMap<K,V> implements SortedMap<K,V>
A sorted map which forwards all its method calls to another sorted map. Subclasses should override one or more methods to modify the behavior of the backing sorted map as desired per the decorator pattern.Warning: The methods of
ForwardingSortedMap
forward indiscriminately to the methods of the delegate. For example, overridingForwardingMap.put(K, V)
alone will not change the behavior ofForwardingMap.putAll(java.util.Map<? extends K, ? extends V>)
, which can lead to unexpected behavior. In this case, you should overrideputAll
as well, either providing your own implementation, or delegating to the providedstandardPutAll
method.default
method warning: This class does not forward calls todefault
methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingSortedMap
.Each of the
standard
methods, where appropriate, use the comparator of the map to test equality for both keys and values, unlikeForwardingMap
.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.- Since:
- 2.0
- Author:
- Mike Bostock, Louis Wasserman
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
ForwardingSortedMap.StandardKeySet
A sensible implementation ofSortedMap.keySet()
in terms of the methods ofForwardingSortedMap
.-
Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap
ForwardingMap.StandardEntrySet, ForwardingMap.StandardValues
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingSortedMap()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Comparator<? super K>
comparator()
Returns the comparator used to order the keys in this map, ornull
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 thantoKey
.K
lastKey()
Returns the last (highest) key currently in this map.protected boolean
standardContainsKey(Object key)
A sensible definition ofForwardingMap.containsKey(java.lang.Object)
in terms of thefirstKey()
method oftailMap(K)
.protected SortedMap<K,V>
standardSubMap(K fromKey, K toKey)
A sensible default implementation ofsubMap(Object, Object)
in terms ofheadMap(Object)
andtailMap(Object)
.SortedMap<K,V>
subMap(K fromKey, K toKey)
Returns a view of the portion of this map whose keys range fromfromKey
, inclusive, totoKey
, exclusive.SortedMap<K,V>
tailMap(K fromKey)
Returns a view of the portion of this map whose keys are greater than or equal tofromKey
.-
Methods inherited from class com.google.common.collect.ForwardingMap
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, standardClear, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString, values
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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
-
-
-
-
Constructor Detail
-
ForwardingSortedMap
protected ForwardingSortedMap()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract SortedMap<K,V> delegate()
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.
-
comparator
@CheckForNull public Comparator<? super K> comparator()
Description copied from interface:java.util.SortedMap
Returns the comparator used to order the keys in this map, ornull
if this map uses the natural ordering of its keys.
-
firstKey
public K firstKey()
Description copied from interface:java.util.SortedMap
Returns the first (lowest) key currently in this map.
-
headMap
public SortedMap<K,V> headMap(K toKey)
Description copied from interface:java.util.SortedMap
Returns a view of the portion of this map whose keys are strictly less thantoKey
. 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.
-
lastKey
public K lastKey()
Description copied from interface:java.util.SortedMap
Returns the last (highest) key currently in this map.
-
subMap
public SortedMap<K,V> subMap(K fromKey, K toKey)
Description copied from interface:java.util.SortedMap
Returns a view of the portion of this map whose keys range fromfromKey
, inclusive, totoKey
, exclusive. (IffromKey
andtoKey
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.- Specified by:
subMap
in interfaceSortedMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
fromKey
- low endpoint (inclusive) of the keys in the returned maptoKey
- high endpoint (exclusive) of the keys in the returned map- Returns:
- a view of the portion of this map whose keys range from
fromKey
, inclusive, totoKey
, exclusive
-
tailMap
public SortedMap<K,V> tailMap(K fromKey)
Description copied from interface:java.util.SortedMap
Returns a view of the portion of this map whose keys are greater than or equal tofromKey
. 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.
-
standardContainsKey
@Beta protected boolean standardContainsKey(@CheckForNull Object key)
A sensible definition ofForwardingMap.containsKey(java.lang.Object)
in terms of thefirstKey()
method oftailMap(K)
. If you overridetailMap(K)
, you may wish to overrideForwardingMap.containsKey(java.lang.Object)
to forward to this implementation.- Overrides:
standardContainsKey
in classForwardingMap<K extends @Nullable Object,V extends @Nullable Object>
- Since:
- 7.0
-
standardSubMap
@Beta protected SortedMap<K,V> standardSubMap(K fromKey, K toKey)
A sensible default implementation ofsubMap(Object, Object)
in terms ofheadMap(Object)
andtailMap(Object)
. In some situations, you may wish to overridesubMap(Object, Object)
to forward to this implementation.- Since:
- 7.0
-
-