Class SafeTreeMap<K,V>

java.lang.Object

com.google.common.collect.testing.SafeTreeMap<K,V>

All Implemented Interfaces:

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

@GwtIncompatible
public final class SafeTreeMap<K,V>
extends Object
implements Serializable, NavigableMap<K,V>

A wrapper around TreeMap that aggressively checks to see if keys are mutually comparable. This implementation passes the navigable map test suites.

Author:

Louis Wasserman

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
SafeTreeMap()
SafeTreeMap(Comparator<? super K> comparator)
SafeTreeMap(Map<? extends K, ? extends V> map)
SafeTreeMap(SortedMap<K, ? extends V> map)

Method Summary

Modifier and Type	Method	Description
@Nullable Map.Entry<K,V>	ceilingEntry(K key)
@Nullable K	ceilingKey(K key)
void	clear()
Comparator<? super K>	comparator()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
NavigableSet<K>	descendingKeySet()
NavigableMap<K,V>	descendingMap()
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(@Nullable Object obj)
@Nullable Map.Entry<K,V>	firstEntry()
K	firstKey()
@Nullable Map.Entry<K,V>	floorEntry(K key)
@Nullable K	floorKey(K key)
@Nullable V	get(Object key)
int	hashCode()
SortedMap<K,V>	headMap(K toKey)
NavigableMap<K,V>	headMap(K toKey, boolean inclusive)
@Nullable Map.Entry<K,V>	higherEntry(K key)
@Nullable K	higherKey(K key)
boolean	isEmpty()
NavigableSet<K>	keySet()
@Nullable Map.Entry<K,V>	lastEntry()
K	lastKey()
@Nullable Map.Entry<K,V>	lowerEntry(K key)
@Nullable K	lowerKey(K key)
NavigableSet<K>	navigableKeySet()
@Nullable Map.Entry<K,V>	pollFirstEntry()
@Nullable Map.Entry<K,V>	pollLastEntry()
@Nullable V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> map)
@Nullable V	remove(Object key)
int	size()
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()
Collection<V>	values()

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

SafeTreeMap

public SafeTreeMap()

SafeTreeMap

public SafeTreeMap(Comparator<? super K> comparator)

SafeTreeMap

public SafeTreeMap(Map<? extends K, ? extends V> map)

SafeTreeMap

public SafeTreeMap(SortedMap<K, ? extends V> map)

Method Details

ceilingEntry

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

Specified by:

ceilingEntry in interface NavigableMap<K,V>

ceilingKey

public @Nullable K ceilingKey(K key)

Specified by:

ceilingKey in interface NavigableMap<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

descendingKeySet

public NavigableSet<K> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K,V>

descendingMap

public NavigableMap<K,V> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

firstEntry

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

Specified by:

firstEntry in interface NavigableMap<K,V>

Specified by:

firstEntry in interface SequencedMap<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

floorEntry

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

Specified by:

floorEntry in interface NavigableMap<K,V>

floorKey

public @Nullable K floorKey(K key)

Specified by:

floorKey in interface NavigableMap<K,V>

get

public @Nullable V get(Object key)

Specified by:

get in interface Map<K,V>

headMap

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

Specified by:

headMap in interface NavigableMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

headMap

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

Specified by:

headMap in interface NavigableMap<K,V>

higherEntry

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

Specified by:

higherEntry in interface NavigableMap<K,V>

higherKey

public @Nullable K higherKey(K key)

Specified by:

higherKey in interface NavigableMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

keySet

public NavigableSet<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

lastEntry

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

Specified by:

lastEntry in interface NavigableMap<K,V>

Specified by:

lastEntry in interface SequencedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

lowerEntry

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

Specified by:

lowerEntry in interface NavigableMap<K,V>

lowerKey

public @Nullable K lowerKey(K key)

Specified by:

lowerKey in interface NavigableMap<K,V>

navigableKeySet

public NavigableSet<K> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K,V>

pollFirstEntry

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

Specified by:

pollFirstEntry in interface NavigableMap<K,V>

Specified by:

pollFirstEntry in interface SequencedMap<K,V>

pollLastEntry

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

Specified by:

pollLastEntry in interface NavigableMap<K,V>

Specified by:

pollLastEntry in interface SequencedMap<K,V>

put

public @Nullable V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

public void putAll(Map<? extends K, ? extends V> map)

Specified by:

putAll in interface Map<K,V>

remove

public @Nullable V remove(Object key)

Specified by:

remove in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

subMap

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

Specified by:

subMap in interface NavigableMap<K,V>

subMap

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

Specified by:

subMap in interface NavigableMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

tailMap

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

Specified by:

tailMap in interface NavigableMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

tailMap

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

Specified by:

tailMap in interface NavigableMap<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

equals

public boolean equals(@Nullable Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object