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

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

All Implemented Interfaces:: Serializable, Map<K,V>, NavigableMap<K,V>, SequencedMap<K,V>, SortedMap<K,V>

@GwtCompatible(emulated=true) public final class ImmutableSortedMap<K,V> extends ImmutableMap<K,V> implements NavigableMap<K,V>

A NavigableMap whose contents will never change, with many other important properties detailed at ImmutableCollection.

Warning: as with any sorted collection, you are strongly advised not to use a Comparator or Comparable type whose comparison behavior is inconsistent with equals. That is, a.compareTo(b) or comparator.compare(a, b) should equal zero if and only if a.equals(b). If this advice is not followed, the resulting map will not correctly obey its specification.

See the Guava User Guide article on immutable collections.

Since:

2.0 (implements NavigableMap since 12.0)

Author:

Jared Levy, Louis Wasserman

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ImmutableSortedMap.Builder<K,V>

A builder for creating immutable sorted map instances, especially public static final maps ("constant maps").

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
Method Summary

Modifier and Type

Method

Description

static <K,V> ImmutableSortedMap.Builder<K,V>

builder()

Deprecated.
Use naturalOrder(), which offers better type-safety.

static <K,V> ImmutableSortedMap.Builder<K,V>

builderWithExpectedSize(int expectedSize)

Deprecated.
Not supported for ImmutableSortedMap.

@Nullable Map.Entry<K,V>

ceilingEntry(K key)

@Nullable K

ceilingKey(K key)

Comparator<? super K>

comparator()

Returns the comparator that orders the keys, which is Ordering.natural() when the natural ordering of the keys is used.

static <K,V> ImmutableSortedMap<K,V>

copyOf(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries)

Returns an immutable map containing the given entries, with keys sorted by their natural ordering.

static <K,V> ImmutableSortedMap<K,V>

copyOf(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries, Comparator<? super K> comparator)

Returns an immutable map containing the given entries, with keys sorted by the provided comparator.

static <K,V> ImmutableSortedMap<K,V>

copyOf(Map<? extends K, ? extends V> map)

Returns an immutable map containing the same entries as map, sorted by the natural ordering of the keys.

static <K,V> ImmutableSortedMap<K,V>

copyOf(Map<? extends K, ? extends V> map, Comparator<? super K> comparator)

Returns an immutable map containing the same entries as map, with keys sorted by the provided comparator.

static <K,V> ImmutableSortedMap<K,V>

copyOfSorted(SortedMap<K, ? extends V> map)

Returns an immutable map containing the same entries as the provided sorted map, with the same ordering.

ImmutableSortedSet<K>

descendingKeySet()

ImmutableSortedMap<K,V>

descendingMap()

ImmutableSet<Map.Entry<K,V>>

entrySet()

Returns an immutable set of the mappings in this map, sorted by the key ordering.

@Nullable Map.Entry<K,V>

firstEntry()

K

firstKey()

@Nullable Map.Entry<K,V>

floorEntry(K key)

@Nullable K

floorKey(K key)

void

forEach(BiConsumer<? super K, ? super V> action)

@Nullable V

get(@Nullable Object key)

ImmutableSortedMap<K,V>

headMap(K toKey)

This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than toKey.

ImmutableSortedMap<K,V>

headMap(K toKey, boolean inclusive)

This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than (or equal to, if inclusive) toKey.

@Nullable Map.Entry<K,V>

higherEntry(K key)

@Nullable K

higherKey(K key)

ImmutableSortedSet<K>

keySet()

Returns an immutable sorted set of the keys in this map.

@Nullable Map.Entry<K,V>

lastEntry()

K

lastKey()

@Nullable Map.Entry<K,V>

lowerEntry(K key)

@Nullable K

lowerKey(K key)

static <K extends Comparable<?>, V> ImmutableSortedMap.Builder<K,V>

naturalOrder()

Returns a builder that creates immutable sorted maps whose keys are ordered by their natural ordering.

ImmutableSortedSet<K>

navigableKeySet()

static <K,V> ImmutableSortedMap<K,V>

of()

Returns the empty sorted map.

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1)

Returns an immutable map containing a single entry.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1)

Deprecated.
Pass a key of type Comparable to use of(Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)

Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.

static <K,V> ImmutableSortedMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)

Deprecated.
Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).

static <K,V> ImmutableSortedMap<K,V>

ofEntries(Map.Entry<? extends K, ? extends V>... entries)

Deprecated.
Use ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...)).

static <K,V> ImmutableSortedMap.Builder<K,V>

orderedBy(Comparator<K> comparator)

Returns a builder that creates immutable sorted maps with an explicit comparator.

final @Nullable Map.Entry<K,V>

pollFirstEntry()

Deprecated.
Unsupported operation.

final @Nullable Map.Entry<K,V>

pollLastEntry()

Deprecated.
Unsupported operation.

static <K extends Comparable<?>, V> ImmutableSortedMap.Builder<K,V>

reverseOrder()

Returns a builder that creates immutable sorted maps whose keys are ordered by the reverse of their natural ordering.

int

size()

ImmutableSortedMap<K,V>

subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

This method returns a ImmutableSortedMap, consisting of the entries whose keys ranges from fromKey to toKey, inclusive or exclusive as indicated by the boolean flags.

ImmutableSortedMap<K,V>

subMap(K fromKey, K toKey)

This method returns a ImmutableSortedMap, consisting of the entries whose keys ranges from fromKey, inclusive, to toKey, exclusive.

ImmutableSortedMap<K,V>

tailMap(K fromKey)

This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than or equals to fromKey.

ImmutableSortedMap<K,V>

tailMap(K fromKey, boolean inclusive)

This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than (or equal to, if inclusive) fromKey.

static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableMap<K,V>>

toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction)

Deprecated.
Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>).

static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableMap<K,V>>

toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction)

Deprecated.
Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>).

static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableSortedMap<K,V>>

toImmutableSortedMap(Comparator<? super K> comparator, Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction)

Returns a Collector that accumulates elements into an ImmutableSortedMap whose keys and values are the result of applying the provided mapping functions to the input elements.

static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableSortedMap<K,V>>

toImmutableSortedMap(Comparator<? super K> comparator, Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction)

Returns a Collector that accumulates elements into an ImmutableSortedMap whose keys and values are the result of applying the provided mapping functions to the input elements.

ImmutableCollection<V>

values()

Returns an immutable collection of the values in this map, sorted by the ordering of the corresponding keys.

Methods inherited from class com.google.common.collect.ImmutableMap
asMultimap, clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.NavigableMap
reversed

Methods inherited from interface java.util.SequencedMap
sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap
putFirst, putLast

Method Details
- toImmutableSortedMap
  
  public static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableSortedMap<K,V>> toImmutableSortedMap(Comparator<? super K> comparator, Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction)
  
  Returns a Collector that accumulates elements into an ImmutableSortedMap whose keys and values are the result of applying the provided mapping functions to the input elements. The generated map is sorted by the specified comparator.
  If the mapped keys contain duplicates (according to the specified comparator), an IllegalArgumentException is thrown when the collection operation is performed. (This differs from the Collector returned by Collectors.toMap(Function, Function), which throws an IllegalStateException.)
  
  Since:
  
  21.0
- toImmutableSortedMap
  
  public static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableSortedMap<K,V>> toImmutableSortedMap(Comparator<? super K> comparator, Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction)
  
  Returns a Collector that accumulates elements into an ImmutableSortedMap whose keys and values are the result of applying the provided mapping functions to the input elements.
  If the mapped keys contain duplicates (according to the comparator), the values are merged using the specified merging function. Entries will appear in the encounter order of the first occurrence of the key.
  
  Since:
  
  21.0
- of
  
  public static <K,V> ImmutableSortedMap<K,V> of()
  
  Returns the empty sorted map.
  Performance note: the instance returned is a singleton.
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1)
  
  Returns an immutable map containing a single entry.
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if the two keys are equal according to their natural ordering
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
  
  Since:
  
  31.0
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
  
  Since:
  
  31.0
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
  
  Since:
  
  31.0
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
  
  Since:
  
  31.0
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
  
  Returns an immutable sorted map containing the given entries, sorted by the natural ordering of their keys.
  
  Throws:
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
  
  Since:
  
  31.0
- copyOf
  
  public static <K,V> ImmutableSortedMap<K,V> copyOf(Map<? extends K, ? extends V> map)
  
  Returns an immutable map containing the same entries as map, sorted by the natural ordering of the keys.
  Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
  This method is not type-safe, as it may be called on a map with keys that are not mutually comparable.
  
  Throws:
  
  ClassCastException - if the keys in map are not mutually comparable
  
  NullPointerException - if any key or value in map is null
  
  IllegalArgumentException - if any two keys are equal according to their natural ordering
- copyOf
  
  public static <K,V> ImmutableSortedMap<K,V> copyOf(Map<? extends K, ? extends V> map, Comparator<? super K> comparator)
  
  Returns an immutable map containing the same entries as map, with keys sorted by the provided comparator.
  Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
  
  Throws:
  
  NullPointerException - if any key or value in map is null
  
  IllegalArgumentException - if any two keys are equal according to the comparator
- copyOf
  
  public static <K,V> ImmutableSortedMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries)
  
  Returns an immutable map containing the given entries, with keys sorted by their natural ordering.
  This method is not type-safe, as it may be called on a map with keys that are not mutually comparable.
  
  Throws:
  
  NullPointerException - if any key or value in map is null
  
  IllegalArgumentException - if any two keys are equal according to the comparator
  
  Since:
  
  19.0
- copyOf
  
  public static <K,V> ImmutableSortedMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries, Comparator<? super K> comparator)
  
  Returns an immutable map containing the given entries, with keys sorted by the provided comparator.
  
  Throws:
  
  NullPointerException - if any key or value in map is null
  
  IllegalArgumentException - if any two keys are equal according to the comparator
  
  Since:
  
  19.0
- copyOfSorted
  
  public static <K,V> ImmutableSortedMap<K,V> copyOfSorted(SortedMap<K, ? extends V> map)
  
  Returns an immutable map containing the same entries as the provided sorted map, with the same ordering.
  Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
  
  Throws:
  
  NullPointerException - if any key or value in map is null
- naturalOrder
  
  public static <K extends Comparable<?>, V> ImmutableSortedMap.Builder<K,V> naturalOrder()
  
  Returns a builder that creates immutable sorted maps whose keys are ordered by their natural ordering. The sorted maps use Ordering.natural() as the comparator.
- orderedBy
  
  public static <K,V> ImmutableSortedMap.Builder<K,V> orderedBy(Comparator<K> comparator)
  
  Returns a builder that creates immutable sorted maps with an explicit comparator. If the comparator has a more general type than the map's keys, such as creating a SortedMap<Integer, String> with a Comparator<Number>, use the ImmutableSortedMap.Builder constructor instead.
  
  Throws:
  
  NullPointerException - if comparator is null
- reverseOrder
  
  public static <K extends Comparable<?>, V> ImmutableSortedMap.Builder<K,V> reverseOrder()
  
  Returns a builder that creates immutable sorted maps whose keys are ordered by the reverse of their natural ordering.
- size
  
  public int size()
  
  Specified by:
  
  size in interface Map<K,V>
- forEach
  
  public void forEach(BiConsumer<? super K, ? super V> action)
  
  Specified by:
  
  forEach in interface Map<K,V>
- get
  
  public @Nullable V get(@Nullable Object key)
  
  Specified by:
  
  get in interface Map<K,V>
  
  Specified by:
  
  get in class ImmutableMap<K,V>
- entrySet
  
  public ImmutableSet<Map.Entry<K,V>> entrySet()
  
  Returns an immutable set of the mappings in this map, sorted by the key ordering.
  
  Specified by:
  
  entrySet in interface Map<K,V>
  
  Specified by:
  
  entrySet in interface SortedMap<K,V>
  
  Overrides:
  
  entrySet in class ImmutableMap<K,V>
- keySet
  
  public ImmutableSortedSet<K> keySet()
  
  Returns an immutable sorted set of the keys in this map.
  
  Specified by:
  
  keySet in interface Map<K,V>
  
  Specified by:
  
  keySet in interface SortedMap<K,V>
  
  Overrides:
  
  keySet in class ImmutableMap<K,V>
- values
  
  public ImmutableCollection<V> values()
  
  Returns an immutable collection of the values in this map, sorted by the ordering of the corresponding keys.
  
  Specified by:
  
  values in interface Map<K,V>
  
  Specified by:
  
  values in interface SortedMap<K,V>
  
  Overrides:
  
  values in class ImmutableMap<K,V>
- comparator
  
  public Comparator<? super K> comparator()
  
  Returns the comparator that orders the keys, which is Ordering.natural() when the natural ordering of the keys is used. Note that its behavior is not consistent with TreeMap.comparator(), which returns null to indicate natural ordering.
  
  Specified by:
  
  comparator in interface SortedMap<K,V>
- firstKey
  
  public K firstKey()
  
  Specified by:
  
  firstKey in interface SortedMap<K,V>
- lastKey
  
  public K lastKey()
  
  Specified by:
  
  lastKey in interface SortedMap<K,V>
- headMap
  
  public ImmutableSortedMap<K,V> headMap(K toKey)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than toKey.
  The SortedMap.headMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a toKey greater than an earlier toKey. However, this method doesn't throw an exception in that situation, but instead keeps the original toKey.
  
  Specified by:
  
  headMap in interface NavigableMap<K,V>
  
  Specified by:
  
  headMap in interface SortedMap<K,V>
- headMap
  
  public ImmutableSortedMap<K,V> headMap(K toKey, boolean inclusive)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than (or equal to, if inclusive) toKey.
  The SortedMap.headMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a toKey greater than an earlier toKey. However, this method doesn't throw an exception in that situation, but instead keeps the original toKey.
  
  Specified by:
  
  headMap in interface NavigableMap<K,V>
  
  Since:
  
  12.0
- subMap
  
  public ImmutableSortedMap<K,V> subMap(K fromKey, K toKey)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys ranges from fromKey, inclusive, to toKey, exclusive.
  The SortedMap.subMap(K, K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a fromKey less than an earlier fromKey. However, this method doesn't throw an exception in that situation, but instead keeps the original fromKey. Similarly, this method keeps the original toKey, instead of throwing an exception, if passed a toKey greater than an earlier toKey.
  
  Specified by:
  
  subMap in interface NavigableMap<K,V>
  
  Specified by:
  
  subMap in interface SortedMap<K,V>
- subMap
  
  public ImmutableSortedMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys ranges from fromKey to toKey, inclusive or exclusive as indicated by the boolean flags.
  The SortedMap.subMap(K, K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a fromKey less than an earlier fromKey. However, this method doesn't throw an exception in that situation, but instead keeps the original fromKey. Similarly, this method keeps the original toKey, instead of throwing an exception, if passed a toKey greater than an earlier toKey.
  
  Specified by:
  
  subMap in interface NavigableMap<K,V>
  
  Since:
  
  12.0
- tailMap
  
  public ImmutableSortedMap<K,V> tailMap(K fromKey)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than or equals to fromKey.
  The SortedMap.tailMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a fromKey less than an earlier fromKey. However, this method doesn't throw an exception in that situation, but instead keeps the original fromKey.
  
  Specified by:
  
  tailMap in interface NavigableMap<K,V>
  
  Specified by:
  
  tailMap in interface SortedMap<K,V>
- tailMap
  
  public ImmutableSortedMap<K,V> tailMap(K fromKey, boolean inclusive)
  
  This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than (or equal to, if inclusive) fromKey.
  The SortedMap.tailMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a fromKey less than an earlier fromKey. However, this method doesn't throw an exception in that situation, but instead keeps the original fromKey.
  
  Specified by:
  
  tailMap in interface NavigableMap<K,V>
  
  Since:
  
  12.0
- 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>
- 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>
- 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>
- 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>
- firstEntry
  
  public @Nullable Map.Entry<K,V> firstEntry()
  
  Specified by:
  
  firstEntry in interface NavigableMap<K,V>
  
  Specified by:
  
  firstEntry in interface SequencedMap<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>
- pollFirstEntry
  
  @CanIgnoreReturnValue @Deprecated public final @Nullable Map.Entry<K,V> pollFirstEntry()
  
  Deprecated.
  Unsupported operation.
  
  Guaranteed to throw an exception and leave the map unmodified.
  
  Specified by:
  
  pollFirstEntry in interface NavigableMap<K,V>
  
  Specified by:
  
  pollFirstEntry in interface SequencedMap<K,V>
  
  Throws:
  
  UnsupportedOperationException - always
- pollLastEntry
  
  @CanIgnoreReturnValue @Deprecated public final @Nullable Map.Entry<K,V> pollLastEntry()
  
  Deprecated.
  Unsupported operation.
  
  Guaranteed to throw an exception and leave the map unmodified.
  
  Specified by:
  
  pollLastEntry in interface NavigableMap<K,V>
  
  Specified by:
  
  pollLastEntry in interface SequencedMap<K,V>
  
  Throws:
  
  UnsupportedOperationException - always
- descendingMap
  
  public ImmutableSortedMap<K,V> descendingMap()
  
  Specified by:
  
  descendingMap in interface NavigableMap<K,V>
- navigableKeySet
  
  public ImmutableSortedSet<K> navigableKeySet()
  
  Specified by:
  
  navigableKeySet in interface NavigableMap<K,V>
- descendingKeySet
  
  public ImmutableSortedSet<K> descendingKeySet()
  
  Specified by:
  
  descendingKeySet in interface NavigableMap<K,V>
- toImmutableMap
  
  @Deprecated public static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableMap<K,V>> toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction)
  
  Deprecated.
  Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>).
  
  Not supported. Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>), which offers better type-safety, instead. This method exists only to hide ImmutableMap.toImmutableMap(java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>) from consumers of ImmutableSortedMap.
  
  Throws:
  
  UnsupportedOperationException - always
- toImmutableMap
  
  @Deprecated public static <T extends @Nullable Object, K, V> Collector<T, ?, ImmutableMap<K,V>> toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction)
  
  Deprecated.
  Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>).
  
  Not supported. Use toImmutableSortedMap(java.util.Comparator<? super K>, java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>), which offers better type-safety, instead. This method exists only to hide ImmutableMap.toImmutableMap(java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>) from consumers of ImmutableSortedMap.
  
  Throws:
  
  UnsupportedOperationException - always
- builder
  
  @Deprecated public static <K,V> ImmutableSortedMap.Builder<K,V> builder()
  
  Deprecated.
  Use naturalOrder(), which offers better type-safety.
  
  Not supported. Use naturalOrder(), which offers better type-safety, instead. This method exists only to hide ImmutableMap.builder() from consumers of ImmutableSortedMap.
  
  Throws:
  
  UnsupportedOperationException - always
- builderWithExpectedSize
  
  @Deprecated public static <K,V> ImmutableSortedMap.Builder<K,V> builderWithExpectedSize(int expectedSize)
  
  Deprecated.
  Not supported for ImmutableSortedMap.
  
  Not supported for ImmutableSortedMap.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1)
  
  Deprecated.
  Pass a key of type Comparable to use of(Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain a non-Comparable key. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls to will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- of
  
  @Deprecated public static <K,V> ImmutableSortedMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
  
  Deprecated.
  Pass keys of type Comparable to use of(Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object, Comparable, Object).
  
  Not supported. You are attempting to create a map that may contain non-Comparable keys. Proper calls will resolve to the version in ImmutableSortedMap, not this dummy version.
  
  Throws:
  
  UnsupportedOperationException - always
- ofEntries
  
  @Deprecated @SafeVarargs public static <K,V> ImmutableSortedMap<K,V> ofEntries(Map.Entry<? extends K, ? extends V>... entries)
  
  Deprecated.
  Use ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...)).
  
  Not supported. Use ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...)).

Class ImmutableSortedMap<K,V>

Nested Class Summary

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

Method Summary

Methods inherited from class com.google.common.collect.ImmutableMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface java.util.NavigableMap

Methods inherited from interface java.util.SequencedMap

Methods inherited from interface java.util.SortedMap

Method Details

toImmutableSortedMap

toImmutableSortedMap

of

of

of

of

of

of

of

of

of

of

of

copyOf

copyOf

copyOf

copyOf

copyOfSorted

naturalOrder

orderedBy

reverseOrder

size

forEach

get

entrySet

keySet

values

comparator

firstKey

lastKey

headMap

headMap

subMap

subMap

tailMap

tailMap

lowerEntry

lowerKey

floorEntry

floorKey

ceilingEntry

ceilingKey

higherEntry

higherKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

descendingMap

navigableKeySet

descendingKeySet

toImmutableMap

toImmutableMap

builder

builderWithExpectedSize

of

of

of

of

of

of

of

of

of

of

ofEntries