Class ForwardingNavigableMap<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>
-
- com.google.common.collect.ForwardingNavigableMap<K,V>
-
- All Implemented Interfaces:
Map<K,V>
,NavigableMap<K,V>
,SortedMap<K,V>
@GwtIncompatible public abstract class ForwardingNavigableMap<K extends @Nullable Object,V extends @Nullable Object> extends ForwardingSortedMap<K,V> implements NavigableMap<K,V>
A navigable map which forwards all its method calls to another navigable map. Subclasses should override one or more methods to modify the behavior of the backing map as desired per the decorator pattern.Warning: The methods of
ForwardingNavigableMap
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 theForwardingNavigableMap
.Each of the
standard
methods uses the map's comparator (or the natural ordering of the elements, if there is no comparator) to test element equality. As a result, if the comparator is not consistent with equals, some of the standard implementations may violate theMap
contract.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:
- 12.0
- Author:
- Louis Wasserman
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
ForwardingNavigableMap.StandardDescendingMap
A sensible implementation ofNavigableMap.descendingMap()
in terms of the methods of thisNavigableMap
.protected class
ForwardingNavigableMap.StandardNavigableKeySet
A sensible implementation ofNavigableMap.navigableKeySet()
in terms of the methods of thisNavigableMap
.-
Nested classes/interfaces inherited from class com.google.common.collect.ForwardingSortedMap
ForwardingSortedMap.StandardKeySet
-
Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap
ForwardingMap.StandardEntrySet, ForwardingMap.StandardValues
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingNavigableMap()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Map.Entry<K,V>
ceilingEntry(K key)
Returns a key-value mapping associated with the least key greater than or equal to the given key, ornull
if there is no such key.K
ceilingKey(K key)
Returns the least key greater than or equal to the given key, ornull
if there is no such key.protected abstract NavigableMap<K,V>
delegate()
Returns the backing delegate instance that methods are forwarded to.NavigableSet<K>
descendingKeySet()
Returns a reverse orderNavigableSet
view of the keys contained in this map.NavigableMap<K,V>
descendingMap()
Returns a reverse order view of the mappings contained in this map.Map.Entry<K,V>
firstEntry()
Returns a key-value mapping associated with the least key in this map, ornull
if the map is empty.Map.Entry<K,V>
floorEntry(K key)
Returns a key-value mapping associated with the greatest key less than or equal to the given key, ornull
if there is no such key.K
floorKey(K key)
Returns the greatest key less than or equal to the given key, ornull
if there is no such key.NavigableMap<K,V>
headMap(K toKey, boolean inclusive)
Returns a view of the portion of this map whose keys are less than (or equal to, ifinclusive
is true)toKey
.Map.Entry<K,V>
higherEntry(K key)
Returns a key-value mapping associated with the least key strictly greater than the given key, ornull
if there is no such key.K
higherKey(K key)
Returns the least key strictly greater than the given key, ornull
if there is no such key.Map.Entry<K,V>
lastEntry()
Returns a key-value mapping associated with the greatest key in this map, ornull
if the map is empty.Map.Entry<K,V>
lowerEntry(K key)
Returns a key-value mapping associated with the greatest key strictly less than the given key, ornull
if there is no such key.K
lowerKey(K key)
Returns the greatest key strictly less than the given key, ornull
if there is no such key.NavigableSet<K>
navigableKeySet()
Returns aNavigableSet
view of the keys contained in this map.Map.Entry<K,V>
pollFirstEntry()
Removes and returns a key-value mapping associated with the least key in this map, ornull
if the map is empty.Map.Entry<K,V>
pollLastEntry()
Removes and returns a key-value mapping associated with the greatest key in this map, ornull
if the map is empty.protected Map.Entry<K,V>
standardCeilingEntry(K key)
protected K
standardCeilingKey(K key)
A sensible definition ofceilingKey(K)
in terms ofceilingEntry
.protected NavigableSet<K>
standardDescendingKeySet()
protected Map.Entry<K,V>
standardFirstEntry()
protected K
standardFirstKey()
A sensible definition ofForwardingSortedMap.firstKey()
in terms offirstEntry
.protected Map.Entry<K,V>
standardFloorEntry(K key)
protected K
standardFloorKey(K key)
A sensible definition offloorKey(K)
in terms offloorEntry
.protected SortedMap<K,V>
standardHeadMap(K toKey)
A sensible definition ofForwardingSortedMap.headMap(Object)
in terms ofheadMap(Object, boolean)
.protected Map.Entry<K,V>
standardHigherEntry(K key)
protected K
standardHigherKey(K key)
A sensible definition ofhigherKey(K)
in terms ofhigherEntry
.protected Map.Entry<K,V>
standardLastEntry()
A sensible definition oflastEntry()
in terms of theiterator()
of theForwardingMap.entrySet()
ofdescendingMap()
.protected K
standardLastKey()
A sensible definition ofForwardingSortedMap.lastKey()
in terms oflastEntry
.protected Map.Entry<K,V>
standardLowerEntry(K key)
protected K
standardLowerKey(K key)
A sensible definition oflowerKey(K)
in terms oflowerEntry
.protected Map.Entry<K,V>
standardPollFirstEntry()
protected Map.Entry<K,V>
standardPollLastEntry()
A sensible definition ofpollFirstEntry()
in terms of theiterator
of theentrySet
ofdescendingMap
.protected SortedMap<K,V>
standardSubMap(K fromKey, K toKey)
A sensible definition ofForwardingSortedMap.subMap(Object, Object)
in terms ofsubMap(Object, boolean, Object, boolean)
.protected SortedMap<K,V>
standardTailMap(K fromKey)
A sensible definition ofForwardingSortedMap.tailMap(Object)
in terms oftailMap(Object, boolean)
.NavigableMap<K,V>
subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
Returns a view of the portion of this map whose keys range fromfromKey
totoKey
.NavigableMap<K,V>
tailMap(K fromKey, boolean inclusive)
Returns a view of the portion of this map whose keys are greater than (or equal to, ifinclusive
is true)fromKey
.-
Methods inherited from class com.google.common.collect.ForwardingSortedMap
comparator, firstKey, headMap, lastKey, standardContainsKey, subMap, tailMap
-
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
-
Methods inherited from interface java.util.NavigableMap
headMap, subMap, tailMap
-
-
-
-
Constructor Detail
-
ForwardingNavigableMap
protected ForwardingNavigableMap()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract NavigableMap<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.
-
lowerEntry
@CheckForNull public Map.Entry<K,V> lowerEntry(K key)
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the greatest key strictly less than the given key, ornull
if there is no such key.- Specified by:
lowerEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- the key- Returns:
- an entry with the greatest key less than
key
, ornull
if there is no such key
-
standardLowerEntry
@CheckForNull protected Map.Entry<K,V> standardLowerEntry(K key)
A sensible definition oflowerEntry(K)
in terms of thelastEntry()
ofheadMap(Object, boolean)
. If you overrideheadMap
, you may wish to overridelowerEntry
to forward to this implementation.
-
lowerKey
@CheckForNull public K lowerKey(K key)
Description copied from interface:java.util.NavigableMap
Returns the greatest key strictly less than the given key, ornull
if there is no such key.
-
standardLowerKey
@CheckForNull protected K standardLowerKey(K key)
A sensible definition oflowerKey(K)
in terms oflowerEntry
. If you overridelowerEntry(K)
, you may wish to overridelowerKey
to forward to this implementation.
-
floorEntry
@CheckForNull public Map.Entry<K,V> floorEntry(K key)
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the greatest key less than or equal to the given key, ornull
if there is no such key.- Specified by:
floorEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- the key- Returns:
- an entry with the greatest key less than or equal to
key
, ornull
if there is no such key
-
standardFloorEntry
@CheckForNull protected Map.Entry<K,V> standardFloorEntry(K key)
A sensible definition offloorEntry(K)
in terms of thelastEntry()
ofheadMap(Object, boolean)
. If you overrideheadMap
, you may wish to overridefloorEntry
to forward to this implementation.
-
floorKey
@CheckForNull public K floorKey(K key)
Description copied from interface:java.util.NavigableMap
Returns the greatest key less than or equal to the given key, ornull
if there is no such key.
-
standardFloorKey
@CheckForNull protected K standardFloorKey(K key)
A sensible definition offloorKey(K)
in terms offloorEntry
. If you overridefloorEntry
, you may wish to overridefloorKey
to forward to this implementation.
-
ceilingEntry
@CheckForNull public Map.Entry<K,V> ceilingEntry(K key)
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the least key greater than or equal to the given key, ornull
if there is no such key.- Specified by:
ceilingEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- the key- Returns:
- an entry with the least key greater than or equal to
key
, ornull
if there is no such key
-
standardCeilingEntry
@CheckForNull protected Map.Entry<K,V> standardCeilingEntry(K key)
A sensible definition ofceilingEntry(K)
in terms of thefirstEntry()
oftailMap(Object, boolean)
. If you overridetailMap
, you may wish to overrideceilingEntry
to forward to this implementation.
-
ceilingKey
@CheckForNull public K ceilingKey(K key)
Description copied from interface:java.util.NavigableMap
Returns the least key greater than or equal to the given key, ornull
if there is no such key.- Specified by:
ceilingKey
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- the key- Returns:
- the least key greater than or equal to
key
, ornull
if there is no such key
-
standardCeilingKey
@CheckForNull protected K standardCeilingKey(K key)
A sensible definition ofceilingKey(K)
in terms ofceilingEntry
. If you overrideceilingEntry
, you may wish to overrideceilingKey
to forward to this implementation.
-
higherEntry
@CheckForNull public Map.Entry<K,V> higherEntry(K key)
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the least key strictly greater than the given key, ornull
if there is no such key.- Specified by:
higherEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- the key- Returns:
- an entry with the least key greater than
key
, ornull
if there is no such key
-
standardHigherEntry
@CheckForNull protected Map.Entry<K,V> standardHigherEntry(K key)
A sensible definition ofhigherEntry(K)
in terms of thefirstEntry()
oftailMap(Object, boolean)
. If you overridetailMap
, you may wish to overridehigherEntry
to forward to this implementation.
-
higherKey
@CheckForNull public K higherKey(K key)
Description copied from interface:java.util.NavigableMap
Returns the least key strictly greater than the given key, ornull
if there is no such key.
-
standardHigherKey
@CheckForNull protected K standardHigherKey(K key)
A sensible definition ofhigherKey(K)
in terms ofhigherEntry
. If you overridehigherEntry
, you may wish to overridehigherKey
to forward to this implementation.
-
firstEntry
@CheckForNull public Map.Entry<K,V> firstEntry()
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the least key in this map, ornull
if the map is empty.- Specified by:
firstEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- an entry with the least key,
or
null
if this map is empty
-
standardFirstEntry
@CheckForNull protected Map.Entry<K,V> standardFirstEntry()
A sensible definition offirstEntry()
in terms of theiterator()
ofForwardingMap.entrySet()
. If you overrideentrySet
, you may wish to overridefirstEntry
to forward to this implementation.
-
standardFirstKey
protected K standardFirstKey()
A sensible definition ofForwardingSortedMap.firstKey()
in terms offirstEntry
. If you overridefirstEntry
, you may wish to overridefirstKey
to forward to this implementation.
-
lastEntry
@CheckForNull public Map.Entry<K,V> lastEntry()
Description copied from interface:java.util.NavigableMap
Returns a key-value mapping associated with the greatest key in this map, ornull
if the map is empty.
-
standardLastEntry
@CheckForNull protected Map.Entry<K,V> standardLastEntry()
A sensible definition oflastEntry()
in terms of theiterator()
of theForwardingMap.entrySet()
ofdescendingMap()
. If you overridedescendingMap
, you may wish to overridelastEntry
to forward to this implementation.
-
standardLastKey
protected K standardLastKey()
A sensible definition ofForwardingSortedMap.lastKey()
in terms oflastEntry
. If you overridelastEntry
, you may wish to overridelastKey
to forward to this implementation.
-
pollFirstEntry
@CheckForNull public Map.Entry<K,V> pollFirstEntry()
Description copied from interface:java.util.NavigableMap
Removes and returns a key-value mapping associated with the least key in this map, ornull
if the map is empty.- Specified by:
pollFirstEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- the removed first entry of this map,
or
null
if this map is empty
-
standardPollFirstEntry
@CheckForNull protected Map.Entry<K,V> standardPollFirstEntry()
A sensible definition ofpollFirstEntry()
in terms of theiterator
ofentrySet
. If you overrideentrySet
, you may wish to overridepollFirstEntry
to forward to this implementation.
-
pollLastEntry
@CheckForNull public Map.Entry<K,V> pollLastEntry()
Description copied from interface:java.util.NavigableMap
Removes and returns a key-value mapping associated with the greatest key in this map, ornull
if the map is empty.- Specified by:
pollLastEntry
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- the removed last entry of this map,
or
null
if this map is empty
-
standardPollLastEntry
@CheckForNull protected Map.Entry<K,V> standardPollLastEntry()
A sensible definition ofpollFirstEntry()
in terms of theiterator
of theentrySet
ofdescendingMap
. If you overridedescendingMap
, you may wish to overridepollFirstEntry
to forward to this implementation.
-
descendingMap
public NavigableMap<K,V> descendingMap()
Description copied from interface:java.util.NavigableMap
Returns a reverse order view of the mappings contained in this map. The descending map is backed by this map, so changes to the map are reflected in the descending map, and vice-versa. If either map is modified while an iteration over a collection view of either map is in progress (except through the iterator's ownremove
operation), the results of the iteration are undefined.The returned map has an ordering equivalent to
Collections.reverseOrder
(comparator())
. The expressionm.descendingMap().descendingMap()
returns a view ofm
essentially equivalent tom
.- Specified by:
descendingMap
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- a reverse order view of this map
-
navigableKeySet
public NavigableSet<K> navigableKeySet()
Description copied from interface:java.util.NavigableMap
Returns aNavigableSet
view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's ownremove
operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove
,Set.remove
,removeAll
,retainAll
, andclear
operations. It does not support theadd
oraddAll
operations.- Specified by:
navigableKeySet
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- a navigable set view of the keys in this map
-
descendingKeySet
public NavigableSet<K> descendingKeySet()
Description copied from interface:java.util.NavigableMap
Returns a reverse orderNavigableSet
view of the keys contained in this map. The set's iterator returns the keys in descending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's ownremove
operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove
,Set.remove
,removeAll
,retainAll
, andclear
operations. It does not support theadd
oraddAll
operations.- Specified by:
descendingKeySet
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- a reverse order navigable set view of the keys in this map
-
standardDescendingKeySet
@Beta protected NavigableSet<K> standardDescendingKeySet()
A sensible definition ofdescendingKeySet()
as thenavigableKeySet
ofdescendingMap()
. (TheForwardingNavigableMap.StandardDescendingMap
implementation implementsnavigableKeySet
on its own, so as not to cause an infinite loop.) If you overridedescendingMap
, you may wish to overridedescendingKeySet
to forward to this implementation.
-
standardSubMap
protected SortedMap<K,V> standardSubMap(K fromKey, K toKey)
A sensible definition ofForwardingSortedMap.subMap(Object, Object)
in terms ofsubMap(Object, boolean, Object, boolean)
. If you overridesubMap(K, boolean, K, boolean)
, you may wish to overridesubMap
to forward to this implementation.- Overrides:
standardSubMap
in classForwardingSortedMap<K extends @Nullable Object,V extends @Nullable Object>
-
subMap
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
Description copied from interface:java.util.NavigableMap
Returns a view of the portion of this map whose keys range fromfromKey
totoKey
. IffromKey
andtoKey
are equal, the returned map is empty unlessfromInclusive
andtoInclusive
are both true. 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 of its range, or to construct a submap either of whose endpoints lie outside its range.- Specified by:
subMap
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
fromKey
- low endpoint of the keys in the returned mapfromInclusive
-true
if the low endpoint is to be included in the returned viewtoKey
- high endpoint of the keys in the returned maptoInclusive
-true
if the high endpoint is to be included in the returned view- Returns:
- a view of the portion of this map whose keys range from
fromKey
totoKey
-
headMap
public NavigableMap<K,V> headMap(K toKey, boolean inclusive)
Description copied from interface:java.util.NavigableMap
Returns a view of the portion of this map whose keys are less than (or equal to, ifinclusive
is true)toKey
. 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:
headMap
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
toKey
- high endpoint of the keys in the returned mapinclusive
-true
if the high endpoint is to be included in the returned view- Returns:
- a view of the portion of this map whose keys are less than
(or equal to, if
inclusive
is true)toKey
-
tailMap
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
Description copied from interface:java.util.NavigableMap
Returns a view of the portion of this map whose keys are greater than (or equal to, ifinclusive
is true)fromKey
. 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:
tailMap
in interfaceNavigableMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
fromKey
- low endpoint of the keys in the returned mapinclusive
-true
if the low endpoint is to be included in the returned view- Returns:
- a view of the portion of this map whose keys are greater than
(or equal to, if
inclusive
is true)fromKey
-
standardHeadMap
protected SortedMap<K,V> standardHeadMap(K toKey)
A sensible definition ofForwardingSortedMap.headMap(Object)
in terms ofheadMap(Object, boolean)
. If you overrideheadMap(K, boolean)
, you may wish to overrideheadMap
to forward to this implementation.
-
standardTailMap
protected SortedMap<K,V> standardTailMap(K fromKey)
A sensible definition ofForwardingSortedMap.tailMap(Object)
in terms oftailMap(Object, boolean)
. If you overridetailMap(K, boolean)
, you may wish to overridetailMap
to forward to this implementation.
-
-