java.lang.Object
- com.google.common.collect.ImmutableMap<K,V>
- - com.google.common.collect.ImmutableSortedMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>, java.util.NavigableMap<K,V>, java.util.SortedMap<K,V>
```
@GwtCompatible(serializable=true,
               emulated=true)
public final class ImmutableSortedMap<K,V>
extends ImmutableMap<K,V>
implements java.util.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:

Serialized Form

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
java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.
`java.util.Map.Entry<K,V>`	`ceilingEntry(K key)`
`K`	`ceilingKey(K key)`
`java.util.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(java.lang.Iterable<? extends java.util.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(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries, java.util.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(java.util.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(java.util.Map<? extends K,? extends V> map, java.util.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(java.util.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<java.util.Map.Entry<K,V>>`	`entrySet()`	Returns an immutable set of the mappings in this map, sorted by the key ordering.
`java.util.Map.Entry<K,V>`	`firstEntry()`
`K`	`firstKey()`
`java.util.Map.Entry<K,V>`	`floorEntry(K key)`
`K`	`floorKey(K key)`
`V`	`get(java.lang.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`.
`java.util.Map.Entry<K,V>`	`higherEntry(K key)`
`K`	`higherKey(K key)`
`ImmutableSortedSet<K>`	`keySet()`	Returns an immutable sorted set of the keys in this map.
`java.util.Map.Entry<K,V>`	`lastEntry()`
`K`	`lastKey()`
`java.util.Map.Entry<K,V>`	`lowerEntry(K key)`
`K`	`lowerKey(K key)`
`static <K extends java.lang.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 java.lang.Comparable<? super K>,V> ImmutableSortedMap<K,V>`	`of(K k1, V v1)`	Returns an immutable map containing a single entry.
`static <K extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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 extends java.lang.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>`	`ofEntries(java.util.Map.Entry<? extends K,? extends V>... entries)`	Deprecated. Use `ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...))`.
`static <K,V> ImmutableSortedMap.Builder<K,V>`	`orderedBy(java.util.Comparator<K> comparator)`	Returns a builder that creates immutable sorted maps with an explicit comparator.
`java.util.Map.Entry<K,V>`	`pollFirstEntry()`	Deprecated. Unsupported operation.
`java.util.Map.Entry<K,V>`	`pollLastEntry()`	Deprecated. Unsupported operation.
`static <K extends java.lang.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 java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>>`	`toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.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 java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>>`	`toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction, java.util.function.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 java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableSortedMap<K,V>>`	`toImmutableSortedMap(java.util.Comparator<? super K> comparator, java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.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 java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableSortedMap<K,V>>`	`toImmutableSortedMap(java.util.Comparator<? super K> comparator, java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction, java.util.function.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, containsKey, containsValue, equals, getOrDefault, hashCode, isEmpty, put, putAll, remove, 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, forEach, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Method Detail

toImmutableSortedMap

@Beta
public static <T extends @Nullable java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableSortedMap<K,V>> toImmutableSortedMap(java.util.Comparator<? super K> comparator,
                                                                                                                                                                    java.util.function.Function<? super T,? extends K> keyFunction,
                                                                                                                                                                    java.util.function.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:: 33.2.0 (available since 21.0 in guava-jre)

toImmutableSortedMap

@Beta
public static <T extends @Nullable java.lang.Object,K,V> java.util.stream.Collector<T,?,ImmutableSortedMap<K,V>> toImmutableSortedMap(java.util.Comparator<? super K> comparator,
                                                                                                                                                                    java.util.function.Function<? super T,? extends K> keyFunction,
                                                                                                                                                                    java.util.function.Function<? super T,? extends V> valueFunction,
                                                                                                                                                                    java.util.function.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:: 33.2.0 (available since 21.0 in guava-jre)

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 java.lang.Comparable<? super K>,V> ImmutableSortedMap<K,V> of(K k1,
                                                                                                   V v1)

Returns an immutable map containing a single entry.