Package com.google.common.collect

Class ImmutableMap<K,V>

java.lang.Object
com.google.common.collect.ImmutableMap<K,V>
All Implemented Interfaces:
Serializable, Map<K,V>
Direct Known Subclasses:
ImmutableBiMap, ImmutableSortedMap
@GwtCompatible(serializable=true, emulated=true) @Deprecated(since="2022-12-01") public abstract class ImmutableMap<K,V> extends Object implements Map<K,V>, Serializable
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
An immutable, hash-based Map with reliable user-specified iteration order. Does not permit null keys or values.

Unlike Collections.unmodifiableMap(java.util.Map<? extends K, ? extends V>), which is a view of a separate map which can still change, an instance of ImmutableMap contains its own data and will never change. ImmutableMap is convenient for public static final maps ("constant maps") and also lets you easily make a "defensive copy" of a map provided to your class by a caller.

Performance notes: unlike HashMap, ImmutableMap is not optimized for element types that have slow Object.equals(java.lang.Object) or Object.hashCode() implementations. You can get better performance by having your element type cache its own hash codes, and by making use of the cached values to short-circuit a slow equals algorithm.

See the Guava User Guide article on immutable collections.

Since:
2.0 (imported from Google Collections Library)
See Also:

  • Method Details

    • of

      public static <K, V> ImmutableMap<K,V> of()
      Deprecated.
      Returns the empty map. This map behaves and performs comparably to Collections.emptyMap(), and is preferable mainly for consistency and maintainability of your code.

    • of

      public static <K, V> ImmutableMap<K,V> of(K k1, V v1)
      Deprecated.
      Returns an immutable map containing a single entry. This map behaves and performs comparably to Collections.singletonMap(K, V) but will not accept a null key or value. It is preferable mainly for consistency and maintainability of your code.

    • of

      public static <K, V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2)
      Deprecated.
      Returns an immutable map containing the given entries, in order.
      Throws:
      IllegalArgumentException - if duplicate keys are provided

    • of

      public static <K, V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
      Deprecated.
      Returns an immutable map containing the given entries, in order.
      Throws:
      IllegalArgumentException - if duplicate keys are provided

    • of

      public static <K, V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
      Deprecated.
      Returns an immutable map containing the given entries, in order.
      Throws:
      IllegalArgumentException - if duplicate keys are provided

    • of

      public static <K, V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
      Deprecated.
      Returns an immutable map containing the given entries, in order.
      Throws:
      IllegalArgumentException - if duplicate keys are provided

    • builder

      public static <K, V> ImmutableMap.Builder<K,V> builder()
      Deprecated.
      Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableMap.Builder constructor.

    • copyOf

      public static <K, V> ImmutableMap<K,V> copyOf(Map<? extends K,? extends V> map)
      Deprecated.
      Returns an immutable map containing the same entries as map. If map somehow contains entries with duplicate keys (for example, if it is a SortedMap whose comparator is not consistent with equals), the results of this method are undefined.

      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

    • put

      @Deprecated public final V put(K k, V v)
      Deprecated.
      Unsupported operation.
      Guaranteed to throw an exception and leave the map unmodified.
      Specified by:
      put in interface Map<K,V>
      Throws:
      UnsupportedOperationException - always

    • remove

      @Deprecated public final V remove(Object o)
      Deprecated.
      Unsupported operation.
      Guaranteed to throw an exception and leave the map unmodified.
      Specified by:
      remove in interface Map<K,V>
      Throws:
      UnsupportedOperationException - always

    • putAll

      @Deprecated public final void putAll(Map<? extends K,? extends V> map)
      Deprecated.
      Unsupported operation.
      Guaranteed to throw an exception and leave the map unmodified.
      Specified by:
      putAll in interface Map<K,V>
      Throws:
      UnsupportedOperationException - always

    • clear

      @Deprecated public final void clear()
      Deprecated.
      Unsupported operation.
      Guaranteed to throw an exception and leave the map unmodified.
      Specified by:
      clear in interface Map<K,V>
      Throws:
      UnsupportedOperationException - always

    • isEmpty

      public boolean isEmpty()
      Deprecated.
      Specified by:
      isEmpty in interface Map<K,V>

    • containsKey

      public boolean containsKey(@Nullable Object key)
      Deprecated.
      Specified by:
      containsKey in interface Map<K,V>

    • containsValue

      public boolean containsValue(@Nullable Object value)
      Deprecated.
      Specified by:
      containsValue in interface Map<K,V>

    • get

      public abstract V get(@Nullable Object key)
      Deprecated.
      Specified by:
      get in interface Map<K,V>

    • entrySet

      public ImmutableSet<Map.Entry<K,V>> entrySet()
      Deprecated.
      Returns an immutable set of the mappings in this map. The entries are in the same order as the parameters used to build this map.
      Specified by:
      entrySet in interface Map<K,V>

    • keySet

      public ImmutableSet<K> keySet()
      Deprecated.
      Returns an immutable set of the keys in this map. These keys are in the same order as the parameters used to build this map.
      Specified by:
      keySet in interface Map<K,V>

    • values

      public ImmutableCollection<V> values()
      Deprecated.
      Returns an immutable collection of the values in this map. The values are in the same order as the parameters used to build this map.
      Specified by:
      values in interface Map<K,V>

    • asMultimap

      @Beta public ImmutableSetMultimap<K,V> asMultimap()
      Deprecated.
      Returns a multimap view of the map.
      Since:
      14.0

    • equals

      public boolean equals(@Nullable Object object)
      Deprecated.
      Specified by:
      equals in interface Map<K,V>
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Specified by:
      hashCode in interface Map<K,V>
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object