SafeTreeMap (Guava Testing Library 20.0 API)

java.lang.Object
- com.google.common.collect.testing.SafeTreeMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>, NavigableMap<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 java.util.Map
  Map.Entry<K,V>

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`Map.Entry<K,V>`	`ceilingEntry(K key)`
`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(Object obj)`
`Map.Entry<K,V>`	`firstEntry()`
`K`	`firstKey()`
`Map.Entry<K,V>`	`floorEntry(K key)`
`K`	`floorKey(K key)`
`V`	`get(Object key)`
`int`	`hashCode()`
`SortedMap<K,V>`	`headMap(K toKey)`
`NavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)`
`Map.Entry<K,V>`	`higherEntry(K key)`
`K`	`higherKey(K key)`
`boolean`	`isEmpty()`
`NavigableSet<K>`	`keySet()`
`Map.Entry<K,V>`	`lastEntry()`
`K`	`lastKey()`
`Map.Entry<K,V>`	`lowerEntry(K key)`
`K`	`lowerKey(K key)`
`NavigableSet<K>`	`navigableKeySet()`
`Map.Entry<K,V>`	`pollFirstEntry()`
`Map.Entry<K,V>`	`pollLastEntry()`
`V`	`put(K key, V value)`
`void`	`putAll(Map<? extends K,? extends V> map)`
`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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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 Detail
  - ceilingEntry
```
public Map.Entry<K,V> ceilingEntry(K key)
```
    Specified by:
    
    ceilingEntry in interface NavigableMap<K,V>
  - ceilingKey
```
public 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 Map.Entry<K,V> firstEntry()
```
    Specified by:
    
    firstEntry in interface NavigableMap<K,V>
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface SortedMap<K,V>
  - floorEntry
```
public Map.Entry<K,V> floorEntry(K key)
```
    Specified by:
    
    floorEntry in interface NavigableMap<K,V>
  - floorKey
```
public K floorKey(K key)
```
    Specified by:
    
    floorKey in interface NavigableMap<K,V>
  - get
```
public 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 Map.Entry<K,V> higherEntry(K key)
```
    Specified by:
    
    higherEntry in interface NavigableMap<K,V>
  - higherKey
```
public 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 Map.Entry<K,V> lastEntry()
```
    Specified by:
    
    lastEntry in interface NavigableMap<K,V>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface SortedMap<K,V>
  - lowerEntry
```
public Map.Entry<K,V> lowerEntry(K key)
```
    Specified by:
    
    lowerEntry in interface NavigableMap<K,V>
  - lowerKey
```
public 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 Map.Entry<K,V> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface NavigableMap<K,V>
  - pollLastEntry
```
public Map.Entry<K,V> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface NavigableMap<K,V>
  - put
```
public 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 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(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

Class SafeTreeMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SafeTreeMap

SafeTreeMap

SafeTreeMap

SafeTreeMap

Method Detail

ceilingEntry

ceilingKey

clear

comparator

containsKey

containsValue

descendingKeySet

descendingMap

entrySet

firstEntry

firstKey

floorEntry

floorKey

get

headMap

headMap

higherEntry

higherKey

isEmpty

keySet

lastEntry

lastKey

lowerEntry

lowerKey

navigableKeySet

pollFirstEntry

pollLastEntry

put

putAll

remove

size

subMap

subMap

tailMap

tailMap

values

equals

hashCode

toString