ImmutableMultimap (Guava: Google Core Libraries for Java 16.0 API)

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

All Implemented Interfaces:

Multimap<K,V>, Serializable

Direct Known Subclasses:

ImmutableListMultimap, ImmutableSetMultimap
```
@GwtCompatible(emulated=true)
public abstract class ImmutableMultimap<K,V>
extends Object
implements Serializable
```
An immutable Multimap. Does not permit null keys or values.
Unlike Multimaps.unmodifiableMultimap(Multimap), which is a view of a separate multimap which can still change, an instance of ImmutableMultimap contains its own data and will never change. ImmutableMultimap is convenient for public static final multimaps ("constant multimaps") and also lets you easily make a "defensive copy" of a multimap provided to your class by a caller.
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.
In addition to methods defined by Multimap, an inverse() method is also supported.
See the Guava User Guide article on immutable collections.

Since:

2.0 (imported from Google Collections Library)

Author:

Jared Levy

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableMultimap.Builder<K,V>` A builder for creating immutable multimap instances, especially `public static final` multimaps ("constant multimaps").

Method Summary

Methods
Modifier and Type	Method and Description
`ImmutableMap<K,Collection<V>>`	`asMap()` Returns an immutable map that associates each key with its corresponding values in the multimap.
`static <K,V> ImmutableMultimap.Builder<K,V>`	`builder()` Returns a new builder.
`void`	`clear()` Deprecated. Unsupported operation.
`boolean`	`containsEntry(Object key, Object value)` Returns `true` if this multimap contains at least one key-value pair with the key `key` and the value `value`.
`boolean`	`containsKey(Object key)` Returns `true` if this multimap contains at least one key-value pair with the key `key`.
`boolean`	`containsValue(Object value)` Returns `true` if this multimap contains at least one key-value pair with the value `value`.
`static <K,V> ImmutableMultimap<K,V>`	`copyOf(Multimap<? extends K,? extends V> multimap)` Returns an immutable multimap containing the same mappings as `multimap`.
`ImmutableCollection<Map.Entry<K,V>>`	`entries()` Returns an immutable collection of all key-value pairs in the multimap.
`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`abstract ImmutableCollection<V>`	`get(K key)` Returns an immutable collection of the values for the given key.
`int`	`hashCode()` Returns the hash code for this multimap.
`abstract ImmutableMultimap<V,K>`	`inverse()` Returns an immutable multimap which is the inverse of this one.
`boolean`	`isEmpty()` Returns `true` if this multimap contains no key-value pairs.
`ImmutableMultiset<K>`	`keys()` Returns a collection, which may contain duplicates, of all keys.
`ImmutableSet<K>`	`keySet()` Returns an immutable set of the distinct keys in this multimap.
`static <K,V> ImmutableMultimap<K,V>`	`of()` Returns an empty multimap.
`static <K,V> ImmutableMultimap<K,V>`	`of(K k1, V v1)` Returns an immutable multimap containing a single entry.
`static <K,V> ImmutableMultimap<K,V>`	`of(K k1, V v1, K k2, V v2)` Returns an immutable multimap containing the given entries, in order.
`static <K,V> ImmutableMultimap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3)` Returns an immutable multimap containing the given entries, in order.
`static <K,V> ImmutableMultimap<K,V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)` Returns an immutable multimap containing the given entries, in order.
`static <K,V> ImmutableMultimap<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 multimap containing the given entries, in order.
`boolean`	`put(K key, V value)` Deprecated. Unsupported operation.
`boolean`	`putAll(K key, Iterable<? extends V> values)` Deprecated. Unsupported operation.
`boolean`	`putAll(Multimap<? extends K,? extends V> multimap)` Deprecated. Unsupported operation.
`boolean`	`remove(Object key, Object value)` Deprecated. Unsupported operation.
`ImmutableCollection<V>`	`removeAll(Object key)` Deprecated. Unsupported operation.
`ImmutableCollection<V>`	`replaceValues(K key, Iterable<? extends V> values)` Deprecated. Unsupported operation.
`int`	`size()` Returns the number of key-value pairs in this multimap.
`String`	`toString()` Returns a string representation of the multimap, generated by calling `toString` on the map returned by `Multimap.asMap()`.
`ImmutableCollection<V>`	`values()` Returns an immutable collection of the values in this multimap.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static <K,V> ImmutableMultimap<K,V> of()
```
    Returns an empty multimap.
  - of
```
public static <K,V> ImmutableMultimap<K,V> of(K k1,
                              V v1)
```
    Returns an immutable multimap containing a single entry.
  - of
```
public static <K,V> ImmutableMultimap<K,V> of(K k1,
                              V v1,
                              K k2,
                              V v2)
```
    Returns an immutable multimap containing the given entries, in order.
  - of
```
public static <K,V> ImmutableMultimap<K,V> of(K k1,
                              V v1,
                              K k2,
                              V v2,
                              K k3,
                              V v3)
```
    Returns an immutable multimap containing the given entries, in order.
  - of
```
public static <K,V> ImmutableMultimap<K,V> of(K k1,
                              V v1,
                              K k2,
                              V v2,
                              K k3,
                              V v3,
                              K k4,
                              V v4)
```
    Returns an immutable multimap containing the given entries, in order.
  - of
```
public static <K,V> ImmutableMultimap<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 multimap containing the given entries, in order.
  - builder
```
public static <K,V> ImmutableMultimap.Builder<K,V> builder()
```
    Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableMultimap.Builder constructor.
  - copyOf
```
public static <K,V> ImmutableMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
```
    Returns an immutable multimap containing the same mappings as multimap. The generated multimap's key and value orderings correspond to the iteration ordering of the multimap.asMap() view.
    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 multimap is null
  - removeAll
```
@Deprecated
public ImmutableCollection<V> removeAll(Object key)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    removeAll in interface Multimap<K,V>
    
    Returns:
    the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.
    
    Throws:
    
    UnsupportedOperationException - always
  - replaceValues
```
@Deprecated
public ImmutableCollection<V> replaceValues(K key,
                                              Iterable<? extends V> values)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    replaceValues in interface Multimap<K,V>
    
    Returns:
    the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.
    
    Throws:
    
    UnsupportedOperationException - always
  - clear
```
@Deprecated
public void clear()
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    clear in interface Multimap<K,V>
    
    Throws:
    
    UnsupportedOperationException - always
  - get
```
public abstract ImmutableCollection<V> get(K key)
```
    Returns an immutable collection of the values for the given key. If no mappings in the multimap have the provided key, an empty immutable collection is returned. The values are in the same order as the parameters used to build this multimap.
    
    Specified by:
    
    get in interface Multimap<K,V>
  - inverse
```
public abstract ImmutableMultimap<V,K> inverse()
```
    Returns an immutable multimap which is the inverse of this one. For every key-value mapping in the original, the result will have a mapping with key and value reversed.
    
    Since:
    
    11.0
  - put
```
@Deprecated
public boolean put(K key,
                     V value)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    put in interface Multimap<K,V>
    
    Returns:
    true if the method increased the size of the multimap, or false if the multimap already contained the key-value pair and doesn't allow duplicates
    
    Throws:
    
    UnsupportedOperationException - always
  - putAll
```
@Deprecated
public boolean putAll(K key,
                        Iterable<? extends V> values)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    putAll in interface Multimap<K,V>
    
    Returns:
    true if the multimap changed
    
    Throws:
    
    UnsupportedOperationException - always
  - putAll
```
@Deprecated
public boolean putAll(Multimap<? extends K,? extends V> multimap)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    putAll in interface Multimap<K,V>
    
    Returns:
    true if the multimap changed
    
    Throws:
    
    UnsupportedOperationException - always
  - remove
```
@Deprecated
public boolean remove(Object key,
                        Object value)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the multimap unmodified.
    
    Specified by:
    
    remove in interface Multimap<K,V>
    
    Returns:
    true if the multimap changed
    
    Throws:
    
    UnsupportedOperationException - always
  - containsKey
```
public boolean containsKey(@Nullable
                  Object key)
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains at least one key-value pair with the key key.
    
    Specified by:
    
    containsKey in interface Multimap<K,V>
  - containsValue
```
public boolean containsValue(@Nullable
                    Object value)
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains at least one key-value pair with the value value.
    
    Specified by:
    
    containsValue in interface Multimap<K,V>
  - size
```
public int size()
```
    Description copied from interface: Multimap
    
    Returns the number of key-value pairs in this multimap.
    Note: this method does not return the number of distinct keys in the multimap, which is given by keySet().size() or asMap().size(). See the opening section of the Multimap class documentation for clarification.
    
    Specified by:
    
    size in interface Multimap<K,V>
  - keySet
```
public ImmutableSet<K> keySet()
```
    Returns an immutable set of the distinct keys in this multimap. These keys are ordered according to when they first appeared during the construction of this multimap.
    
    Specified by:
    
    keySet in interface Multimap<K,V>
  - asMap
```
public ImmutableMap<K,Collection<V>> asMap()
```
    Returns an immutable map that associates each key with its corresponding values in the multimap.
    
    Specified by:
    
    asMap in interface Multimap<K,V>
  - entries
```
public ImmutableCollection<Map.Entry<K,V>> entries()
```
    Returns an immutable collection of all key-value pairs in the multimap. Its iterator traverses the values for the first key, the values for the second key, and so on.
    
    Specified by:
    
    entries in interface Multimap<K,V>
  - keys
```
public ImmutableMultiset<K> keys()
```
    Returns a collection, which may contain duplicates, of all keys. The number of times a key appears in the returned multiset equals the number of mappings the key has in the multimap. Duplicate keys appear consecutively in the multiset's iteration order.
    
    Specified by:
    
    keys in interface Multimap<K,V>
  - values
```
public ImmutableCollection<V> values()
```
    Returns an immutable collection of the values in this multimap. Its iterator traverses the values for the first key, the values for the second key, and so on.
    
    Specified by:
    
    values in interface Multimap<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.
    
    Specified by:
    
    isEmpty in interface Multimap<K,V>
  - containsEntry
```
public boolean containsEntry(@Nullable
                    Object key,
                    @Nullable
                    Object value)
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains at least one key-value pair with the key key and the value value.
    
    Specified by:
    
    containsEntry in interface Multimap<K,V>
  - equals
```
public boolean equals(@Nullable
             Object object)
```
    Description copied from class: java.lang.Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Specified by:
    
    equals in interface Multimap<K,V>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    object - the reference object with which to compare.
    
    Returns:
    true if this object is the same as the obj argument; false otherwise.
    See Also:
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this multimap.
    The hash code of a multimap is defined as the hash code of the map view, as returned by Multimap.asMap().
    
    Specified by:
    
    hashCode in interface Multimap<K,V>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for this object.
    See Also:
    Map.hashCode()
  - toString
```
public String toString()
```
    Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.asMap().
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of the multimap

Class ImmutableMultimap<K,V>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

of

of

of

builder

copyOf

removeAll

replaceValues

clear

get

inverse

put

putAll

putAll

remove

containsKey

containsValue

size

keySet

asMap

entries

keys

values

isEmpty

containsEntry

equals

hashCode

toString