com.google.common.collect

Class ImmutableSetMultimap<K,V>

java.lang.Object

com.google.common.collect.AbstractMultimap<K,V>

com.google.common.collect.ImmutableMultimap<K,V>

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

All Implemented Interfaces:

Multimap<K,V>, SetMultimap<K,V>, java.io.Serializable

Direct Known Subclasses:

EmptyImmutableSetMultimap

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

A SetMultimap 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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableSetMultimap.Builder<K,V> A builder for creating immutable SetMultimap instances, especially public static final multimaps ("constant multimaps").
private static class	ImmutableSetMultimap.EntrySet<K,V>

Nested classes/interfaces inherited from class com.google.common.collect.ImmutableMultimap

ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys

Field Summary

Fields

Modifier and Type	Field and Description
private ImmutableSet<V>	emptySet Returned by get() when a missing key is provided.
private ImmutableSet<java.util.Map.Entry<K,V>>	entries
private ImmutableSetMultimap<V,K>	inverse
private static long	serialVersionUID

Fields inherited from class com.google.common.collect.ImmutableMultimap

map, size

Constructor Summary

Constructors

Constructor and Description
ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map, int size, java.util.Comparator<? super V> valueComparator)

Method Summary

Modifier and Type	Method and Description
static <K,V> ImmutableSetMultimap.Builder<K,V>	builder() Returns a new ImmutableSetMultimap.Builder.
static <K,V> ImmutableSetMultimap<K,V>	copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries) Returns an immutable multimap containing the specified entries.
static <K,V> ImmutableSetMultimap<K,V>	copyOf(Multimap<? extends K,? extends V> multimap) Returns an immutable set multimap containing the same mappings as multimap.
private static <K,V> ImmutableSetMultimap<K,V>	copyOf(Multimap<? extends K,? extends V> multimap, java.util.Comparator<? super V> valueComparator)
private static <V> ImmutableSet<V>	emptySet(java.util.Comparator<? super V> valueComparator)
ImmutableSet<java.util.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.
private ImmutableSetMultimap<V,K>	invert()
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.
private void	readObject(java.io.ObjectInputStream stream)
ImmutableSet<V>	removeAll(java.lang.Object key) Deprecated. Unsupported operation.
ImmutableSet<V>	replaceValues(K key, java.lang.Iterable<? extends V> values) Deprecated. Unsupported operation.
(package private) java.util.Comparator<? super V>	valueComparator()
private static <V> ImmutableSet.Builder<V>	valuesBuilder(java.util.Comparator<? super V> valueComparator)
private static <V> ImmutableSet<V>	valueSet(java.util.Comparator<? super V> valueComparator, java.util.Collection<? extends V> values)
private void	writeObject(java.io.ObjectOutputStream stream)

Methods inherited from class com.google.common.collect.ImmutableMultimap

asMap, clear, containsKey, containsValue, createAsMap, createEntries, createKeys, createValues, entryIterator, isPartialView, keys, keySet, put, putAll, putAll, remove, size, valueIterator, values

Methods inherited from class com.google.common.collect.AbstractMultimap

containsEntry, createKeySet, equals, hashCode, isEmpty, toString

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

Field Detail

emptySet

private final transient ImmutableSet<V> emptySet

Returned by get() when a missing key is provided. Also holds the comparator, if any, used for values.

inverse

private transient ImmutableSetMultimap<V,K> inverse

entries

private transient ImmutableSet<java.util.Map.Entry<K,V>> entries

serialVersionUID

@GwtIncompatible
private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ImmutableSetMultimap

ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map,
                     int size,
                     @Nullable
                     java.util.Comparator<? super V> valueComparator)

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:

java.lang.NullPointerException - if any key or value in multimap is null

copyOf

private static <K,V> ImmutableSetMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap,
                                                      java.util.Comparator<? super V> valueComparator)

copyOf

@Beta
public static <K,V> ImmutableSetMultimap<K,V> copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries)

Returns an immutable multimap containing the specified entries. The returned multimap iterates over keys in the order they were first encountered in the input, and the values for each key are iterated in the order they were encountered. If two values for the same key are equal, the first value encountered is used.

Throws:

java.lang.NullPointerException - if any key, value, or entry is null

Since:

19.0

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>

inverse

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

invert

private ImmutableSetMultimap<V,K> invert()

removeAll

@Deprecated
public ImmutableSet<V> removeAll(java.lang.Object key)

Deprecated. Unsupported operation.

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>

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:

java.lang.UnsupportedOperationException - always

replaceValues

@Deprecated
public ImmutableSet<V> replaceValues(K key,
                                                 java.lang.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>

Specified by:

replaceValues in interface SetMultimap<K,V>

Overrides:

replaceValues in class ImmutableMultimap<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:

java.lang.UnsupportedOperationException - always

entries

public ImmutableSet<java.util.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>

valueSet

private static <V> ImmutableSet<V> valueSet(@Nullable
                                            java.util.Comparator<? super V> valueComparator,
                                            java.util.Collection<? extends V> values)

emptySet

private static <V> ImmutableSet<V> emptySet(@Nullable
                                            java.util.Comparator<? super V> valueComparator)

valuesBuilder

private static <V> ImmutableSet.Builder<V> valuesBuilder(@Nullable
                                                         java.util.Comparator<? super V> valueComparator)

writeObject

@GwtIncompatible
private void writeObject(java.io.ObjectOutputStream stream)
                                   throws java.io.IOException

Throws:

java.io.IOException

valueComparator

@Nullable
java.util.Comparator<? super V> valueComparator()

readObject

@GwtIncompatible
private void readObject(java.io.ObjectInputStream stream)
                                  throws java.io.IOException,
                                         java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException