Class ForwardingNavigableMap.StandardDescendingMap

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<K,V>

com.google.common.collect.ForwardingNavigableMap.StandardDescendingMap

All Implemented Interfaces:

Map<K,V>, NavigableMap<K,V>, SequencedMap<K,V>, SortedMap<K,V>

Enclosing class:

ForwardingNavigableMap<K extends @Nullable Object, V extends @Nullable Object>

protected class ForwardingNavigableMap.StandardDescendingMap
extends ForwardingMap<K,V>

A sensible implementation of NavigableMap.descendingMap() in terms of the methods of this NavigableMap. In many cases, you may wish to override ForwardingNavigableMap.descendingMap() to forward to this implementation or a subclass thereof.

In particular, this map iterates over entries with repeated calls to NavigableMap.lowerEntry(K). If a more efficient means of iteration is available, you may wish to override the entryIterator() method of this class.

Since:

12.0

Author:

Louis Wasserman

Nested Class Summary

Nested classes/interfaces inherited from class ForwardingMap

ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues

Modifier and Type	Class	Description
protected class	ForwardingMap.StandardEntrySet	A sensible implementation of Map.entrySet() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsKey(Object), ForwardingMap.get(Object), ForwardingMap.isEmpty(), ForwardingMap.remove(Object), and ForwardingMap.size().
protected class	ForwardingMap.StandardKeySet	A sensible implementation of Map.keySet() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsKey(Object), ForwardingMap.isEmpty(), ForwardingMap.remove(Object), ForwardingMap.size(), and the Set.iterator() method of ForwardingMap.entrySet().
protected class	ForwardingMap.StandardValues	A sensible implementation of Map.values() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsValue(Object), ForwardingMap.isEmpty(), ForwardingMap.size(), and the Set.iterator() method of ForwardingMap.entrySet().

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
StandardDescendingMap()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
@Nullable Map.Entry<K,V>	ceilingEntry(K key)
K	ceilingKey(K key)
Comparator<? super K>	comparator()
protected final Map<K,V>	delegate()	Returns the backing delegate instance that methods are forwarded to.
NavigableSet<K>	descendingKeySet()
NavigableMap<K,V>	descendingMap()
protected Iterator<Map.Entry<K,V>>	entryIterator()
Set<Map.Entry<K,V>>	entrySet()
@Nullable Map.Entry<K,V>	firstEntry()
K	firstKey()
@Nullable Map.Entry<K,V>	floorEntry(K key)
K	floorKey(K key)
SortedMap<K,V>	headMap(K toKey)
NavigableMap<K,V>	headMap(K toKey, boolean inclusive)
@Nullable Map.Entry<K,V>	higherEntry(K key)
K	higherKey(K key)
Set<K>	keySet()
@Nullable Map.Entry<K,V>	lastEntry()
K	lastKey()
@Nullable Map.Entry<K,V>	lowerEntry(K key)
K	lowerKey(K key)
NavigableSet<K>	navigableKeySet()
@Nullable Map.Entry<K,V>	pollFirstEntry()
@Nullable Map.Entry<K,V>	pollLastEntry()
NavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)
NavigableMap<K,V>	tailMap(K fromKey, boolean inclusive)
String	toString()	Returns the string representation generated by the delegate's toString method.
Collection<V>	values()

Methods inherited from class ForwardingMap

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(@Nullable Object key)
boolean	containsValue(@Nullable Object value)
boolean	equals(@Nullable Object object)
V	get(@Nullable Object key)
int	hashCode()
boolean	isEmpty()
V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> map)
V	remove(@Nullable Object key)
int	size()
protected void	standardClear()	A sensible definition of ForwardingMap.clear() in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardContainsKey(@Nullable Object key)	A sensible, albeit inefficient, definition of ForwardingMap.containsKey(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardContainsValue(@Nullable Object value)	A sensible definition of ForwardingMap.containsValue(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardEquals(@Nullable Object object)	A sensible definition of ForwardingMap.equals(Object) in terms of the equals method of ForwardingMap.entrySet().
protected int	standardHashCode()	A sensible definition of ForwardingMap.hashCode() in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardIsEmpty()	A sensible definition of ForwardingMap.isEmpty() in terms of the iterator method of ForwardingMap.entrySet().
protected void	standardPutAll(Map<? extends K, ? extends V> map)	A sensible definition of ForwardingMap.putAll(Map) in terms of ForwardingMap.put(Object, Object).
protected V	standardRemove(@Nullable Object key)	A sensible, albeit inefficient, definition of ForwardingMap.remove(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected String	standardToString()	A sensible definition of ForwardingObject.toString() in terms of the iterator method of ForwardingMap.entrySet().

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface NavigableMap

reversed

Methods inherited from interface SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

putFirst, putLast

Constructor Details

StandardDescendingMap

public StandardDescendingMap()

Constructor for use by subclasses.

Method Details

entryIterator

protected Iterator<Map.Entry<K,V>> entryIterator()

delegate

protected final Map<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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingMap<K extends @Nullable Object, V extends @Nullable Object>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

lowerEntry

public @Nullable Map.Entry<K,V> lowerEntry(K key)

Specified by:

lowerEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

lowerKey

public K lowerKey(K key)

Specified by:

lowerKey in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

floorEntry

public @Nullable Map.Entry<K,V> floorEntry(K key)

Specified by:

floorEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

floorKey

public K floorKey(K key)

Specified by:

floorKey in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

ceilingEntry

public @Nullable Map.Entry<K,V> ceilingEntry(K key)

Specified by:

ceilingEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

ceilingKey

public K ceilingKey(K key)

Specified by:

ceilingKey in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

higherEntry

public @Nullable Map.Entry<K,V> higherEntry(K key)

Specified by:

higherEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

higherKey

public K higherKey(K key)

Specified by:

higherKey in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

firstEntry

public @Nullable Map.Entry<K,V> firstEntry()

Specified by:

firstEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

firstEntry in interface SequencedMap<K extends @Nullable Object, V extends @Nullable Object>

lastEntry

public @Nullable Map.Entry<K,V> lastEntry()

Specified by:

lastEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

lastEntry in interface SequencedMap<K extends @Nullable Object, V extends @Nullable Object>

pollFirstEntry

public @Nullable Map.Entry<K,V> pollFirstEntry()

Specified by:

pollFirstEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

pollFirstEntry in interface SequencedMap<K extends @Nullable Object, V extends @Nullable Object>

pollLastEntry

public @Nullable Map.Entry<K,V> pollLastEntry()

Specified by:

pollLastEntry in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

pollLastEntry in interface SequencedMap<K extends @Nullable Object, V extends @Nullable Object>

descendingMap

public NavigableMap<K,V> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

entrySet in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

entrySet in class ForwardingMap<K extends @Nullable Object, V extends @Nullable Object>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

keySet in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

keySet in class ForwardingMap<K extends @Nullable Object, V extends @Nullable Object>

navigableKeySet

public NavigableSet<K> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

descendingKeySet

public NavigableSet<K> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

subMap

public NavigableMap<K,V> subMap(K fromKey,
 boolean fromInclusive,
 K toKey,
 boolean toInclusive)

Specified by:

subMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

subMap

public SortedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

subMap in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

headMap

public NavigableMap<K,V> headMap(K toKey,
 boolean inclusive)

Specified by:

headMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

headMap in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

tailMap

public NavigableMap<K,V> tailMap(K fromKey,
 boolean inclusive)

Specified by:

tailMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface NavigableMap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

tailMap in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

values

public Collection<V> values()

Specified by:

values in interface Map<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

values in interface SortedMap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

values in class ForwardingMap<K extends @Nullable Object, V extends @Nullable Object>

toString

public String toString()

Description copied from class: ForwardingObject

Returns the string representation generated by the delegate's toString method.

Overrides:

toString in class ForwardingObject