Package com.google.common.collect
Class ImmutableSetMultimap<K,V>
- java.lang.Object
-
- com.google.common.collect.AbstractMultimap<K,V>
-
- com.google.common.collect.BaseImmutableMultimap<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>
ASetMultimap
whose contents will never change, with many other important properties detailed atImmutableCollection
.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 Description static class
ImmutableSetMultimap.Builder<K,V>
A builder for creating immutableSetMultimap
instances, especiallypublic static final
multimaps ("constant multimaps").private static class
ImmutableSetMultimap.EntrySet<K,V>
private static class
ImmutableSetMultimap.SetFieldSettersHolder
-
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableMultimap
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys
-
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries
-
-
Field Summary
Fields Modifier and Type Field 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 Description ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map, int size, java.util.Comparator<? super V> valueComparator)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <K,V>
ImmutableSetMultimap.Builder<K,V>builder()
Returns a newImmutableSetMultimap.Builder
.static <K,V>
ImmutableSetMultimap<K,V>copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable set multimap containing the same mappings asmultimap
.private static <K,V>
ImmutableSetMultimap<K,V>copyOf(Multimap<? extends K,? extends V> multimap, java.util.Comparator<? super V> valueComparator)
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.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.static <T,K,V>
java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>>flatteningToImmutableSetMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends V>> valuesFunction)
Returns aCollector
accumulating entries into anImmutableSetMultimap
.(package private) static <K,V>
ImmutableSetMultimap<K,V>fromMapEntries(java.util.Collection<? extends java.util.Map.Entry<? extends K,? extends java.util.Collection<? extends V>>> mapEntries, java.util.Comparator<? super V> valueComparator)
Creates an ImmutableSetMultimap from an asMap.entrySet.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.static <T,K,V>
java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>>toImmutableSetMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableSetMultimap
whose keys and values are the result of applying the provided mapping functions to the input elements.(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, createKeySet, createValues, entryIterator, entrySpliterator, forEach, isPartialView, keys, keySet, put, putAll, putAll, remove, size, valueIterator, values
-
Methods inherited from class com.google.common.collect.AbstractMultimap
containsEntry, equals, hashCode, isEmpty, toString, valueSpliterator
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, forEach, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
-
Methods inherited from interface com.google.common.collect.SetMultimap
asMap, equals
-
-
-
-
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, java.util.Comparator<? super V> valueComparator)
-
-
Method Detail
-
toImmutableSetMultimap
public static <T,K,V> java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>> toImmutableSetMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableSetMultimap
whose keys and values are the result of applying the provided mapping functions to the input elements.For streams with defined encounter order (as defined in the Ordering section of the
java.util.stream
Javadoc), that order is preserved, but entries are grouped by key.Example:
static final Multimap<Character, String> FIRST_LETTER_MULTIMAP = Stream.of("banana", "apple", "carrot", "asparagus", "cherry") .collect(toImmutableSetMultimap(str -> str.charAt(0), str -> str.substring(1))); // is equivalent to static final Multimap<Character, String> FIRST_LETTER_MULTIMAP = new ImmutableSetMultimap.Builder<Character, String>() .put('b', "anana") .putAll('a', "pple", "sparagus") .putAll('c', "arrot", "herry") .build();
- Since:
- 21.0
-
flatteningToImmutableSetMultimap
public static <T,K,V> java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>> flatteningToImmutableSetMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends V>> valuesFunction)
Returns aCollector
accumulating entries into anImmutableSetMultimap
. Each input element is mapped to a key and a stream of values, each of which are put into the resultingMultimap
, in the encounter order of the stream and the encounter order of the streams of values.Example:
static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP = Stream.of("banana", "apple", "carrot", "asparagus", "cherry") .collect( flatteningToImmutableSetMultimap( str -> str.charAt(0), str -> str.substring(1).chars().mapToObj(c -> (char) c)); // is equivalent to static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP = ImmutableSetMultimap.<Character, Character>builder() .putAll('b', Arrays.asList('a', 'n', 'a', 'n', 'a')) .putAll('a', Arrays.asList('p', 'p', 'l', 'e')) .putAll('c', Arrays.asList('a', 'r', 'r', 'o', 't')) .putAll('a', Arrays.asList('s', 'p', 'a', 'r', 'a', 'g', 'u', 's')) .putAll('c', Arrays.asList('h', 'e', 'r', 'r', 'y')) .build(); // after deduplication, the resulting multimap is equivalent to static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP = ImmutableSetMultimap.<Character, Character>builder() .putAll('b', Arrays.asList('a', 'n')) .putAll('a', Arrays.asList('p', 'l', 'e', 's', 'a', 'r', 'g', 'u')) .putAll('c', Arrays.asList('a', 'r', 'o', 't', 'h', 'e', 'y')) .build();
}- Since:
- 21.0
-
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 toObject.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 toObject.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 toObject.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 toObject.equals(java.lang.Object)
) after the first are ignored.
-
builder
public static <K,V> ImmutableSetMultimap.Builder<K,V> builder()
Returns a newImmutableSetMultimap.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 asmultimap
. The generated multimap's key and value orderings correspond to the iteration ordering of themultimap.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 inmultimap
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
-
fromMapEntries
static <K,V> ImmutableSetMultimap<K,V> fromMapEntries(java.util.Collection<? extends java.util.Map.Entry<? extends K,? extends java.util.Collection<? extends V>>> mapEntries, java.util.Comparator<? super V> valueComparator)
Creates an ImmutableSetMultimap from an asMap.entrySet.
-
get
public ImmutableSet<V> get(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.
-
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 theImmutableMultimap
specified in theImmutableMultimap
class.- Specified by:
inverse
in classImmutableMultimap<K,V>
-
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 interfaceMultimap<K,V>
- Specified by:
removeAll
in interfaceSetMultimap<K,V>
- Overrides:
removeAll
in classImmutableMultimap<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 interfaceMultimap<K,V>
- Specified by:
replaceValues
in interfaceSetMultimap<K,V>
- Overrides:
replaceValues
in classImmutableMultimap<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.
-
valueSet
private static <V> ImmutableSet<V> valueSet(java.util.Comparator<? super V> valueComparator, java.util.Collection<? extends V> values)
-
emptySet
private static <V> ImmutableSet<V> emptySet(java.util.Comparator<? super V> valueComparator)
-
valuesBuilder
private static <V> ImmutableSet.Builder<V> valuesBuilder(java.util.Comparator<? super V> valueComparator)
-
writeObject
@GwtIncompatible private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
- Throws:
java.io.IOException
-
valueComparator
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
-
-