## com.google.common.collect
Class ImmutableSetMultimap<K,V>

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

All Implemented Interfaces:
  Multimap<K,V>, SetMultimap<K,V>, Serializable

    @GwtCompatible(serializable=true,
                   emulated=true)
    public class ImmutableSetMultimap<K,V>

extends ImmutableMultimap<K,V>
implements SetMultimap<K,V>

An immutable `SetMultimap` with reliable user-specified key and value iteration order. Does not permit null keys or values.

Unlike `Multimaps.unmodifiableSetMultimap(SetMultimap)`, which is a view of a separate multimap which can still change, an instance of `ImmutableSetMultimap` contains its own data and will never change. `ImmutableSetMultimap` 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.

See the Guava User Guide article on immutable collections.

Since:
  2.0 (imported from Google Collections Library)
Author:
  Mike Ward
See Also:
  Serialized Form

Nested Class Summary
`static class` `ImmutableSetMultimap.Builder<K,V>` A builder for creating immutable `SetMultimap` instances, especially `public static final` multimaps ("constant multimaps").

Method Summary

`static

`<K,V> ImmutableSetMultimap.Builder<K,V>`

`

`builder()`
Returns a new `ImmutableSetMultimap.Builder`.

`static

`<K,V> ImmutableSetMultimap<K,V>`

`

`copyOf(Multimap<? extends K,? extends V> multimap)`
Returns an immutable set multimap containing the same mappings as `multimap`.

`ImmutableSet<Map.Entry<K,V>>` `entries()` Returns an immutable collection of all key-value pairs in the multimap.
`ImmutableSet<V>` `get(K key)` Returns an immutable set of the values for the given key.
`ImmutableSetMultimap<V,K>` `inverse()` Returns an immutable multimap which is the inverse of this one.

`static

`<K,V> ImmutableSetMultimap<K,V>`

`

`of()`
Returns the empty multimap.

`static

`<K,V> ImmutableSetMultimap<K,V>`

`

`of(K k1, V v1)`
Returns an immutable multimap containing a single entry.

`static

`<K,V> ImmutableSetMultimap<K,V>`

`

`of(K k1, V v1, K k2, V v2)`
Returns an immutable multimap containing the given entries, in order.

`static

`<K,V> ImmutableSetMultimap<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> ImmutableSetMultimap<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> ImmutableSetMultimap<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.

`ImmutableSet<V>` `removeAll(Object key)` Guaranteed to throw an exception and leave the multimap unmodified.
`ImmutableSet<V>` `replaceValues(K key, Iterable<? extends V> values)` Guaranteed to throw an exception and leave the multimap unmodified.

Methods inherited from class com.google.common.collect.ImmutableMultimap
`asMap, clear, containsEntry, containsKey, containsValue, equals, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, toString, values`

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

Methods inherited from interface com.google.common.collect.SetMultimap
`asMap, equals`

Methods inherited from interface com.google.common.collect.Multimap
`clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values`

Method Detail

### of

    public static <K,V> ImmutableSetMultimap<K,V> of()

  Returns the empty multimap.

### of

    public static <K,V> ImmutableSetMultimap<K,V> of(K k1,
                                                     V v1)

  Returns an immutable multimap containing a single entry.

### of

    public static <K,V> ImmutableSetMultimap<K,V> of(K k1,
                                                     V v1,
                                                     K k2,
                                                     V v2)

  Returns an immutable multimap containing the given entries, in order. Repeated occurrences of an entry (according to `Object.equals(java.lang.Object)`) after the first are ignored.

### of

    public static <K,V> ImmutableSetMultimap<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. Repeated occurrences of an entry (according to `Object.equals(java.lang.Object)`) after the first are ignored.

### of

    public static <K,V> ImmutableSetMultimap<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. Repeated occurrences of an entry (according to `Object.equals(java.lang.Object)`) after the first are ignored.

### of

    public static <K,V> ImmutableSetMultimap<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. Repeated occurrences of an entry (according to `Object.equals(java.lang.Object)`) after the first are ignored.

### builder

    public static <K,V> ImmutableSetMultimap.Builder<K,V> builder()

  Returns a new `ImmutableSetMultimap.Builder`.

### copyOf

    public static <K,V> ImmutableSetMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)

  Returns an immutable set 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. Repeated occurrences of an entry in the multimap after the first are ignored.

  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

### get

    public ImmutableSet<V> get(@Nullable
                               K key)

  Returns an immutable set of the values for the given key. If no mappings in the multimap have the provided key, an empty immutable set 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>`
  Specified by:
    `get` in interface `SetMultimap<K,V>`
  Specified by:
    `get` in class `ImmutableMultimap<K,V>`
  Parameters:
    `key` - key to search for in multimap
  Returns:
    the collection of values that the key maps to

### inverse

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

  Because an inverse of a set multimap cannot contain multiple pairs with the same key and value, this method returns an `ImmutableSetMultimap` rather than the `ImmutableMultimap` specified in the `ImmutableMultimap` class.

  Specified by:
    `inverse` in class `ImmutableMultimap<K,V>`
  Since:
    11.0

### removeAll

    public ImmutableSet<V> removeAll(Object key)

  Guaranteed to throw an exception and leave the multimap unmodified.

  Specified by:
    `removeAll` in interface `Multimap<K,V>`
  Specified by:
    `removeAll` in interface `SetMultimap<K,V>`
  Overrides:
    `removeAll` in class `ImmutableMultimap<K,V>`
  Parameters:
    `key` - key of entries to remove from the multimap
  Returns:
    the collection of removed values, or an empty collection if no values were associated with the provided key. The collection may be modifiable, but updating it will have no effect on the multimap.
  Throws:
    `UnsupportedOperationException` - always

### replaceValues

    public ImmutableSet<V> replaceValues(K key,
                                         Iterable<? extends V> values)

  Guaranteed to throw an exception and leave the multimap unmodified.

  Specified by:
    `replaceValues` in interface `Multimap<K,V>`
  Specified by:
    `replaceValues` in interface `SetMultimap<K,V>`
  Overrides:
    `replaceValues` in class `ImmutableMultimap<K,V>`
  Parameters:
    `key` - key to store in the multimap
    `values` - values to store in the multimap
  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

### entries

    public ImmutableSet<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>`
  Specified by:
    `entries` in interface `SetMultimap<K,V>`
  Overrides:
    `entries` in class `ImmutableMultimap<K,V>`
  Returns:
    collection of map entries consisting of key-value pairs

Copyright © 2010-2012. All Rights Reserved.