Class ForwardingNavigableMap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.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:
java.util.Map<K,V>
,java.util.NavigableMap<K,V>
,java.util.SortedMap<K,V>
@GwtIncompatible public abstract class ForwardingNavigableMap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object> extends ForwardingSortedMap<K,V> implements java.util.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 java.util.Map.Entry<K,V>
ceilingEntry(K key)
K
ceilingKey(K key)
protected abstract java.util.NavigableMap<K,V>
delegate()
Returns the backing delegate instance that methods are forwarded to.java.util.NavigableSet<K>
descendingKeySet()
java.util.NavigableMap<K,V>
descendingMap()
java.util.Map.Entry<K,V>
firstEntry()
java.util.Map.Entry<K,V>
floorEntry(K key)
K
floorKey(K key)
java.util.NavigableMap<K,V>
headMap(K toKey, boolean inclusive)
java.util.Map.Entry<K,V>
higherEntry(K key)
K
higherKey(K key)
java.util.Map.Entry<K,V>
lastEntry()
java.util.Map.Entry<K,V>
lowerEntry(K key)
K
lowerKey(K key)
java.util.NavigableSet<K>
navigableKeySet()
java.util.Map.Entry<K,V>
pollFirstEntry()
java.util.Map.Entry<K,V>
pollLastEntry()
protected java.util.Map.Entry<K,V>
standardCeilingEntry(K key)
protected K
standardCeilingKey(K key)
A sensible definition ofceilingKey(K)
in terms ofceilingEntry
.protected java.util.NavigableSet<K>
standardDescendingKeySet()
protected java.util.Map.Entry<K,V>
standardFirstEntry()
protected K
standardFirstKey()
A sensible definition ofForwardingSortedMap.firstKey()
in terms offirstEntry
.protected java.util.Map.Entry<K,V>
standardFloorEntry(K key)
protected K
standardFloorKey(K key)
A sensible definition offloorKey(K)
in terms offloorEntry
.protected java.util.SortedMap<K,V>
standardHeadMap(K toKey)
A sensible definition ofForwardingSortedMap.headMap(Object)
in terms ofheadMap(Object, boolean)
.protected java.util.Map.Entry<K,V>
standardHigherEntry(K key)
protected K
standardHigherKey(K key)
A sensible definition ofhigherKey(K)
in terms ofhigherEntry
.protected java.util.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 java.util.Map.Entry<K,V>
standardLowerEntry(K key)
protected K
standardLowerKey(K key)
A sensible definition oflowerKey(K)
in terms oflowerEntry
.protected java.util.Map.Entry<K,V>
standardPollFirstEntry()
protected java.util.Map.Entry<K,V>
standardPollLastEntry()
A sensible definition ofpollFirstEntry()
in terms of theiterator
of theentrySet
ofdescendingMap
.protected java.util.SortedMap<K,V>
standardSubMap(K fromKey, K toKey)
A sensible definition ofForwardingSortedMap.subMap(Object, Object)
in terms ofsubMap(Object, boolean, Object, boolean)
.protected java.util.SortedMap<K,V>
standardTailMap(K fromKey)
A sensible definition ofForwardingSortedMap.tailMap(Object)
in terms oftailMap(Object, boolean)
.java.util.NavigableMap<K,V>
subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
java.util.NavigableMap<K,V>
tailMap(K fromKey, boolean inclusive)
-
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
-
-
-
-
Constructor Detail
-
ForwardingNavigableMap
protected ForwardingNavigableMap()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract java.util.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 java.util.Map.Entry<K,V> lowerEntry(K key)
-
standardLowerEntry
@CheckForNull protected java.util.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)
-
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 java.util.Map.Entry<K,V> floorEntry(K key)
-
standardFloorEntry
@CheckForNull protected java.util.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)
-
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 java.util.Map.Entry<K,V> ceilingEntry(K key)
-
standardCeilingEntry
@CheckForNull protected java.util.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)
-
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 java.util.Map.Entry<K,V> higherEntry(K key)
-
standardHigherEntry
@CheckForNull protected java.util.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)
-
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 java.util.Map.Entry<K,V> firstEntry()
-
standardFirstEntry
@CheckForNull protected java.util.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 java.util.Map.Entry<K,V> lastEntry()
-
standardLastEntry
@CheckForNull protected java.util.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 java.util.Map.Entry<K,V> pollFirstEntry()
-
standardPollFirstEntry
@CheckForNull protected java.util.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 java.util.Map.Entry<K,V> pollLastEntry()
-
standardPollLastEntry
@CheckForNull protected java.util.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 java.util.NavigableMap<K,V> descendingMap()
-
navigableKeySet
public java.util.NavigableSet<K> navigableKeySet()
-
descendingKeySet
public java.util.NavigableSet<K> descendingKeySet()
-
standardDescendingKeySet
protected java.util.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 java.util.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 java.lang.Object,V extends @Nullable java.lang.Object>
-
subMap
public java.util.NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
-
standardHeadMap
protected java.util.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 java.util.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.
-
-