Class 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
    • Method Detail

      • toImmutableSortedMap

        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:
        21.0
      • toImmutableSortedMap

        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:
        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 java.lang.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 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.
        Throws:
        java.lang.IllegalArgumentException - if the two keys are equal according to their natural ordering
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
        Since:
        31.0
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
        Since:
        31.0
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
        Since:
        31.0
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
        Since:
        31.0
      • of

        public 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.
        Throws:
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
        Since:
        31.0
      • copyOf

        public 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.

        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:
        java.lang.ClassCastException - if the keys in map are not mutually comparable
        java.lang.NullPointerException - if any key or value in map is null
        java.lang.IllegalArgumentException - if any two keys are equal according to their natural ordering
      • copyOf

        public 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.

        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:
        java.lang.NullPointerException - if any key or value in map is null
        java.lang.IllegalArgumentException - if any two keys are equal according to the comparator
      • copyOf

        @Beta
        public 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.

        This method is not type-safe, as it may be called on a map with keys that are not mutually comparable.

        Throws:
        java.lang.NullPointerException - if any key or value in map is null
        java.lang.IllegalArgumentException - if any two keys are equal according to the comparator
        Since:
        19.0
      • copyOf

        @Beta
        public 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.
        Throws:
        java.lang.NullPointerException - if any key or value in map is null
        java.lang.IllegalArgumentException - if any two keys are equal according to the comparator
        Since:
        19.0
      • copyOfSorted

        public 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.

        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:
        java.lang.NullPointerException - if any key or value in map is null
      • naturalOrder

        public 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. The sorted maps use Ordering.natural() as the comparator.
      • orderedBy

        public 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. 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:
        java.lang.NullPointerException - if comparator is null
      • reverseOrder

        public 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.
      • size

        public int size()
        Specified by:
        size in interface java.util.Map<K,​V>
      • forEach

        public void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)
        Specified by:
        forEach in interface java.util.Map<K,​V>
      • entrySet

        public ImmutableSet<java.util.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 java.util.Map<K,​V>
        Specified by:
        entrySet in interface java.util.SortedMap<K,​V>
        Overrides:
        entrySet in class ImmutableMap<K,​V>
      • keySet

        public ImmutableSortedSet<KkeySet()
        Returns an immutable sorted set of the keys in this map.
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Specified by:
        keySet in interface java.util.SortedMap<K,​V>
        Overrides:
        keySet in class ImmutableMap<K,​V>
      • values

        public ImmutableCollection<Vvalues()
        Returns an immutable collection of the values in this map, sorted by the ordering of the corresponding keys.
        Specified by:
        values in interface java.util.Map<K,​V>
        Specified by:
        values in interface java.util.SortedMap<K,​V>
        Overrides:
        values in class ImmutableMap<K,​V>
      • comparator

        public java.util.Comparator<? super Kcomparator()
        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 java.util.SortedMap<K,​V>
      • firstKey

        public K firstKey()
        Specified by:
        firstKey in interface java.util.SortedMap<K,​V>
      • lastKey

        public K lastKey()
        Specified by:
        lastKey in interface java.util.SortedMap<K,​V>
      • headMap

        public ImmutableSortedMap<K,​VheadMap​(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 java.util.NavigableMap<K,​V>
        Specified by:
        headMap in interface java.util.SortedMap<K,​V>
      • headMap

        public ImmutableSortedMap<K,​VheadMap​(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 java.util.NavigableMap<K,​V>
        Since:
        12.0
      • subMap

        public ImmutableSortedMap<K,​VsubMap​(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 java.util.NavigableMap<K,​V>
        Specified by:
        subMap in interface java.util.SortedMap<K,​V>
      • subMap

        public ImmutableSortedMap<K,​VsubMap​(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 java.util.NavigableMap<K,​V>
        Since:
        12.0
      • tailMap

        public ImmutableSortedMap<K,​VtailMap​(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 java.util.NavigableMap<K,​V>
        Specified by:
        tailMap in interface java.util.SortedMap<K,​V>
      • tailMap

        public ImmutableSortedMap<K,​VtailMap​(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 java.util.NavigableMap<K,​V>
        Since:
        12.0
      • lowerEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VlowerEntry​(K key)
        Specified by:
        lowerEntry in interface java.util.NavigableMap<K,​V>
      • floorEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VfloorEntry​(K key)
        Specified by:
        floorEntry in interface java.util.NavigableMap<K,​V>
      • ceilingEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VceilingEntry​(K key)
        Specified by:
        ceilingEntry in interface java.util.NavigableMap<K,​V>
      • higherEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VhigherEntry​(K key)
        Specified by:
        higherEntry in interface java.util.NavigableMap<K,​V>
      • firstEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VfirstEntry()
        Specified by:
        firstEntry in interface java.util.NavigableMap<K,​V>
      • lastEntry

        @CheckForNull
        public java.util.Map.Entry<K,​VlastEntry()
        Specified by:
        lastEntry in interface java.util.NavigableMap<K,​V>
      • pollFirstEntry

        @CanIgnoreReturnValue
        @Deprecated
        @CheckForNull
        public final java.util.Map.Entry<K,​VpollFirstEntry()
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the map unmodified.
        Specified by:
        pollFirstEntry in interface java.util.NavigableMap<K,​V>
        Throws:
        java.lang.UnsupportedOperationException - always
      • pollLastEntry

        @CanIgnoreReturnValue
        @Deprecated
        @CheckForNull
        public final java.util.Map.Entry<K,​VpollLastEntry()
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the map unmodified.
        Specified by:
        pollLastEntry in interface java.util.NavigableMap<K,​V>
        Throws:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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.
        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:
        java.lang.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)
        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:
        java.lang.UnsupportedOperationException - always
      • ofEntries

        @Deprecated
        public static <K,​V> ImmutableSortedMap<K,​V> ofEntries​(java.util.Map.Entry<? extends K,​? extends V>... entries)
        Deprecated.
        Use ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...)).
        Not supported. Use ImmutableSortedMap.copyOf(ImmutableMap.ofEntries(...)).