Class ImmutableSetMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,,V> SetMultimap<K,,V> Serializable
- Direct Known Subclasses:
EmptyImmutableSetMultimap
SetMultimap whose contents will never change, with many other important properties
detailed at ImmutableCollection.
Warning: As in all SetMultimaps, do not modify either a key or a value
of a ImmutableSetMultimap in a way that affects its Object.equals(java.lang.Object) behavior.
Undefined behavior and bugs will result.
See the Guava User Guide article on immutable collections.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA builder for creating immutableSetMultimapinstances, especiallypublic static finalmultimaps ("constant multimaps").private static final classprivate static final classNested classes/interfaces inherited from class com.google.common.collect.ImmutableMultimap
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.KeysNested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ImmutableSet<V>Returned by get() when a missing key is provided.private ImmutableSet<Map.Entry<K,V>> private ImmutableSetMultimap<V,K> private static final longFields inherited from class com.google.common.collect.ImmutableMultimap
map, size -
Constructor Summary
ConstructorsConstructorDescriptionImmutableSetMultimap(ImmutableMap<K, ImmutableSet<V>> map, int size, Comparator<? super V> valueComparator) -
Method Summary
Modifier and TypeMethodDescriptionstatic <K,V> ImmutableSetMultimap.Builder<K, V> builder()Returns a newImmutableSetMultimap.Builder.static <K,V> ImmutableSetMultimap<K, V> Returns an immutable set multimap containing the same mappings asmultimap.private static <K,V> ImmutableSetMultimap<K, V> copyOf(Multimap<? extends K, ? extends V> multimap, Comparator<? super V> valueComparator) static <K,V> ImmutableSetMultimap<K, V> Returns an immutable multimap containing the specified entries.private static <V> ImmutableSet<V>emptySet(Comparator<? super V> valueComparator) entries()Returns an immutable collection of all key-value pairs in the multimap.static <T,K, V> Collector<T, ?, ImmutableSetMultimap<K, V>> flatteningToImmutableSetMultimap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends Stream<? extends V>> valuesFunction) Returns aCollectoraccumulating entries into anImmutableSetMultimap.(package private) static <K,V> ImmutableSetMultimap<K, V> fromMapEntries(Collection<? extends Map.Entry<? extends K, ? extends Collection<? extends V>>> mapEntries, Comparator<? super V> valueComparator) Creates an ImmutableSetMultimap from an asMap.entrySet.Returns an immutable set of the values for the given key.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 voidreadObject(ObjectInputStream stream) final ImmutableSet<V>Deprecated.Unsupported operation.final ImmutableSet<V>replaceValues(K key, Iterable<? extends V> values) Deprecated.Unsupported operation.static <T,K, V> Collector<T, ?, ImmutableSetMultimap<K, V>> toImmutableSetMultimap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollectorthat accumulates elements into anImmutableSetMultimapwhose keys and values are the result of applying the provided mapping functions to the input elements.(package private) Comparator<? super V>private static <V> ImmutableSet.Builder<V>valuesBuilder(Comparator<? super V> valueComparator) private static <V> ImmutableSet<V>valueSet(Comparator<? super V> valueComparator, Collection<? extends V> values) private voidwriteObject(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, valuesMethods inherited from class com.google.common.collect.AbstractMultimap
containsEntry, equals, hashCode, isEmpty, toString, valueSpliteratorMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, forEach, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, valuesMethods inherited from interface com.google.common.collect.SetMultimap
asMap, equals
-
Field Details
-
emptySet
Returned by get() when a missing key is provided. Also holds the comparator, if any, used for values. -
inverse
-
entries
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
ImmutableSetMultimap
ImmutableSetMultimap(ImmutableMap<K, ImmutableSet<V>> map, int size, @CheckForNull Comparator<? super V> valueComparator)
-
-
Method Details
-
toImmutableSetMultimap
public static <T,K, Collector<T,V> ?, toImmutableSetMultimapImmutableSetMultimap<K, V>> (Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollectorthat accumulates elements into anImmutableSetMultimapwhose 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.streamJavadoc), 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, Collector<T,V> ?, flatteningToImmutableSetMultimapImmutableSetMultimap<K, V>> (Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends Stream<? extends V>> valuesFunction) Returns aCollectoraccumulating 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
Returns the empty multimap.Performance note: the instance returned is a singleton.
-
of
Returns an immutable multimap containing a single entry. -
of
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
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
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
Returns a newImmutableSetMultimap.Builder. -
copyOf
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:
NullPointerException- if any key or value inmultimapis null
-
copyOf
private static <K,V> ImmutableSetMultimap<K,V> copyOf(Multimap<? extends K, ? extends V> multimap, @CheckForNull Comparator<? super V> valueComparator) -
copyOf
public static <K,V> ImmutableSetMultimap<K,V> copyOf(Iterable<? extends 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:
NullPointerException- if any key, value, or entry is null- Since:
- 19.0
-
fromMapEntries
static <K,V> ImmutableSetMultimap<K,V> fromMapEntries(Collection<? extends Map.Entry<? extends K, ? extends Collection<? extends V>>> mapEntries, @CheckForNull Comparator<? super V> valueComparator) Creates an ImmutableSetMultimap from an asMap.entrySet. -
get
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
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
ImmutableSetMultimaprather than theImmutableMultimapspecified in theImmutableMultimapclass.- Specified by:
inversein classImmutableMultimap<K,V>
-
invert
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
removeAllin interfaceMultimap<K,V> - Specified by:
removeAllin interfaceSetMultimap<K,V> - Overrides:
removeAllin 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:
UnsupportedOperationException- always
-
replaceValues
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
replaceValuesin interfaceMultimap<K,V> - Specified by:
replaceValuesin interfaceSetMultimap<K,V> - Overrides:
replaceValuesin 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:
UnsupportedOperationException- always
-
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(@CheckForNull Comparator<? super V> valueComparator, Collection<? extends V> values) -
emptySet
-
valuesBuilder
private static <V> ImmutableSet.Builder<V> valuesBuilder(@CheckForNull Comparator<? super V> valueComparator) -
writeObject
- Throws:
IOException
-
valueComparator
-
readObject
- Throws:
IOExceptionClassNotFoundException
-