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

@DoNotMock("Use ImmutableMap.of or another implementation") @GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V> extends Object implements Map<K,V>, Serializable
A Map whose contents will never change, with many other important properties detailed at ImmutableCollection.

See the Guava User Guide article on immutable collections.

Since:
2.0
Author:
Jesse Wilson, Kevin Bourrillion
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    A builder for creating immutable map instances, especially public static final maps ("constant maps").

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

    Map.Entry<K extends Object,V extends Object>
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a multimap view of the map.
    static <K, V> ImmutableMap.Builder<K,V>
    Returns a new builder.
    static <K, V> ImmutableMap.Builder<K,V>
    builderWithExpectedSize(int expectedSize)
    Returns a new builder, expecting the specified number of entries to be added.
    final void
    Deprecated.
    Unsupported operation.
    final V
    compute(K key, BiFunction<? super K,? super @Nullable V,? extends V> remappingFunction)
    Deprecated.
    Unsupported operation.
    final V
    computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
    Deprecated.
    Unsupported operation.
    final V
    computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
    Deprecated.
    Unsupported operation.
    boolean
     
    boolean
     
    static <K, V> ImmutableMap<K,V>
    copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
    Returns an immutable map containing the specified entries.
    static <K, V> ImmutableMap<K,V>
    copyOf(Map<? extends K,? extends V> map)
    Returns an immutable map containing the same entries as map.
    Returns an immutable set of the mappings in this map.
    boolean
    equals(Object object)
     
    abstract V
    get(Object key)
     
    final V
    getOrDefault(Object key, V defaultValue)
     
    int
     
    boolean
     
    Returns an immutable set of the keys in this map, in the same order that they appear in entrySet.
    final V
    merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
    Deprecated.
    Unsupported operation.
    static <K, V> ImmutableMap<K,V>
    of()
    Returns the empty map.
    static <K, V> ImmutableMap<K,V>
    of(K k1, V v1)
    Returns an immutable map containing a single entry.
    static <K, V> ImmutableMap<K,V>
    of(K k1, V v1, K k2, V v2)
    Returns an immutable map containing the given entries, in order.
    static <K, V> ImmutableMap<K,V>
    of(K k1, V v1, K k2, V v2, K k3, V v3)
    Returns an immutable map containing the given entries, in order.
    static <K, V> ImmutableMap<K,V>
    of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
    Returns an immutable map containing the given entries, in order.
    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)
    Returns an immutable map containing the given entries, in order.
    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, K k6, V v6)
    Returns an immutable map containing the given entries, in order.
    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, K k6, V v6, K k7, V v7)
    Returns an immutable map containing the given entries, in order.
    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, K k6, V v6, K k7, V v7, K k8, V v8)
    Returns an immutable map containing the given entries, in order.
    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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
    Returns an immutable map containing the given entries, in order.
    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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
    Returns an immutable map containing the given entries, in order.
    static <K, V> ImmutableMap<K,V>
    ofEntries(Map.Entry<? extends K,? extends V>... entries)
    Returns an immutable map containing the given entries, in order.
    final V
    put(K k, V v)
    Deprecated.
    Unsupported operation.
    final void
    putAll(Map<? extends K,? extends V> map)
    Deprecated.
    Unsupported operation.
    final V
    putIfAbsent(K key, V value)
    Deprecated.
    Unsupported operation.
    final V
    Deprecated.
    Unsupported operation.
    final boolean
    remove(Object key, Object value)
    Deprecated.
    Unsupported operation.
    final V
    replace(K key, V value)
    Deprecated.
    Unsupported operation.
    final boolean
    replace(K key, V oldValue, V newValue)
    Deprecated.
    Unsupported operation.
    final void
    replaceAll(BiFunction<? super K,? super V,? extends V> function)
    Deprecated.
    Unsupported operation.
    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)
    Returns a Collector that accumulates elements into an ImmutableMap 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,?,ImmutableMap<K,V>>
    toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction, BinaryOperator<V> mergeFunction)
    Returns a Collector that accumulates elements into an ImmutableMap whose keys and values are the result of applying the provided mapping functions to the input elements.
     
    Returns an immutable collection of the values in this map, in the same order that they appear in entrySet.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Map

    forEach, size
  • Method Details