Class ImmutableMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,
,V> Serializable
- Direct Known Subclasses:
ImmutableListMultimap
,ImmutableSetMultimap
Multimap
whose contents will never change, with many other important properties
detailed at ImmutableCollection
.
Warning: avoid direct usage of ImmutableMultimap
as a type (as with
Multimap
itself). Prefer subtypes such as ImmutableSetMultimap
or ImmutableListMultimap
, which have well-defined AbstractMultimap.equals(java.lang.Object)
semantics, thus avoiding a common
source of bugs and confusion.
Note: every ImmutableMultimap
offers an inverse()
view, so there is no
need for a distinct ImmutableBiMultimap
type.
Key-grouped iteration. All view collections follow the same iteration order. In all
current implementations, the iteration order always keeps multiple entries with the same key
together. Any creation method that would customarily respect insertion order (such as copyOf(Multimap)
) instead preserves key-grouped order by inserting entries for an existing key
immediately after the last entry having that key.
See the Guava User Guide article on immutable collections.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder for creating immutable multimap instances, especiallypublic static final
multimaps ("constant multimaps").private static class
(package private) static class
(package private) class
private static final class
private static final class
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries, AbstractMultimap.EntrySet
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final ImmutableMap
<K, ? extends ImmutableCollection<V>> private static final long
(package private) final int
-
Constructor Summary
ConstructorsConstructorDescriptionImmutableMultimap
(ImmutableMap<K, ? extends ImmutableCollection<V>> map, int size) -
Method Summary
Modifier and TypeMethodDescriptionasMap()
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.static <K,
V> ImmutableMultimap.Builder <K, V> builderWithExpectedKeys
(int expectedKeys) Returns a new builder with a hint for how many distinct keys are expected to be added.final void
clear()
Deprecated.Unsupported operation.boolean
containsKey
(Object key) Returnstrue
if this multimap contains at least one key-value pair with the keykey
.boolean
containsValue
(Object value) Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.static <K,
V> ImmutableMultimap <K, V> Returns an immutable multimap containing the same mappings asmultimap
, in the "key-grouped" iteration order described in the class documentation.static <K,
V> ImmutableMultimap <K, V> Returns an immutable multimap containing the specified entries.(package private) Map
<K, Collection<V>> (package private) ImmutableCollection
<Map.Entry<K, V>> (package private) ImmutableMultiset
<K> (package private) ImmutableCollection
<V> entries()
Returns an immutable collection of all key-value pairs in the multimap.(package private) UnmodifiableIterator
<Map.Entry<K, V>> (package private) Spliterator
<Map.Entry<K, V>> void
forEach
(BiConsumer<? super K, ? super V> action) Performs the given action for all key-value pairs contained in this multimap.abstract ImmutableCollection
<V> Returns an immutable collection of the values for the given key.abstract ImmutableMultimap
<V, K> inverse()
Returns an immutable multimap which is the inverse of this one.(package private) boolean
Returnstrue
if this immutable multimap's implementation contains references to user-created objects that aren't accessible via this multimap's methods.keys()
Returns an immutable multiset containing all the keys in this multimap, in the same order and with the same frequencies as they appear in this multimap; to get only a single occurrence of each key, usekeySet()
.keySet()
Returns an immutable set of the distinct keys in this multimap, in the same order as they appear 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 the "key-grouped" insertion order described in the class documentation.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 the "key-grouped" insertion order described in the class documentation.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 the "key-grouped" insertion order described in the class documentation.final boolean
Deprecated.Unsupported operation.final boolean
Deprecated.Unsupported operation.final boolean
Deprecated.Unsupported operation.final boolean
Deprecated.Unsupported operation.Deprecated.Unsupported operation.replaceValues
(K key, Iterable<? extends V> values) Deprecated.Unsupported operation.int
size()
Returns the number of key-value pairs in this multimap.(package private) UnmodifiableIterator
<V> values()
Returns an immutable collection of the values in this multimap.Methods inherited from class com.google.common.collect.AbstractMultimap
containsEntry, equals, hashCode, isEmpty, toString, valueSpliterator
-
Field Details
-
map
-
size
final transient int size -
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
ImmutableMultimap
ImmutableMultimap(ImmutableMap<K, ? extends ImmutableCollection<V>> map, int size)
-
-
Method Details
-
of
Returns an 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. -
of
Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation. -
of
Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation. -
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 the "key-grouped" insertion order described in the class documentation. -
builder
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableMultimap.Builder
constructor. -
builderWithExpectedKeys
Returns a new builder with a hint for how many distinct keys are expected to be added. The generated builder is equivalent to that returned bybuilder()
, but may perform better ifexpectedKeys
is a good estimate.- Throws:
IllegalArgumentException
- ifexpectedKeys
is negative- Since:
- 33.3.0
-
copyOf
Returns an immutable multimap containing the same mappings asmultimap
, in the "key-grouped" iteration order described in the class documentation.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 inmultimap
is null
-
copyOf
public static <K,V> ImmutableMultimap<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.- Throws:
NullPointerException
- if any key, value, or entry is null- Since:
- 19.0
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
removeAll
in interfaceMultimap<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:
replaceValues
in interfaceMultimap<K,
V> - Overrides:
replaceValues
in classAbstractMultimap<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.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
clear
in interfaceMultimap<K,
V> - Throws:
UnsupportedOperationException
- always
-
get
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. -
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.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
put
in interfaceMultimap<K,
V> - Overrides:
put
in classAbstractMultimap<K,
V> - Returns:
true
if the method increased the size of the multimap, orfalse
if the multimap already contained the key-value pair and doesn't allow duplicates- Throws:
UnsupportedOperationException
- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
putAll
in interfaceMultimap<K,
V> - Overrides:
putAll
in classAbstractMultimap<K,
V> - Returns:
true
if the multimap changed- Throws:
UnsupportedOperationException
- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
putAll
in interfaceMultimap<K,
V> - Overrides:
putAll
in classAbstractMultimap<K,
V> - Returns:
true
if the multimap changed- Throws:
UnsupportedOperationException
- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
remove
in interfaceMultimap<K,
V> - Overrides:
remove
in classAbstractMultimap<K,
V> - Returns:
true
if the multimap changed- Throws:
UnsupportedOperationException
- always
-
isPartialView
boolean isPartialView()Returnstrue
if this immutable multimap's implementation contains references to user-created objects that aren't accessible via this multimap's methods. This is generally used to determine whethercopyOf
implementations should make an explicit copy to avoid memory leaks. -
containsKey
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.- Specified by:
containsKey
in interfaceMultimap<K,
V>
-
containsValue
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.- Specified by:
containsValue
in interfaceMultimap<K,
V> - Overrides:
containsValue
in classAbstractMultimap<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()
orasMap().size()
. See the opening section of theMultimap
class documentation for clarification. -
keySet
Returns an immutable set of the distinct keys in this multimap, in the same order as they appear in this multimap. -
createKeySet
- Specified by:
createKeySet
in classAbstractMultimap<K,
V>
-
asMap
Returns an immutable map that associates each key with its corresponding values in the multimap. Keys and values appear in the same order as in this multimap. -
createAsMap
Map<K,Collection<V>> createAsMap()- Specified by:
createAsMap
in classAbstractMultimap<K,
V>
-
entries
Returns an immutable collection of all key-value pairs in the multimap. -
createEntries
ImmutableCollection<Map.Entry<K,V>> createEntries()- Specified by:
createEntries
in classAbstractMultimap<K,
V>
-
entryIterator
UnmodifiableIterator<Map.Entry<K,V>> entryIterator()- Specified by:
entryIterator
in classAbstractMultimap<K,
V>
-
entrySpliterator
Spliterator<Map.Entry<K,V>> entrySpliterator()- Overrides:
entrySpliterator
in classAbstractMultimap<K,
V>
-
forEach
Description copied from interface:Multimap
Performs the given action for all key-value pairs contained in this multimap. If an ordering is specified by theMultimap
implementation, actions will be performed in the order of iteration ofMultimap.entries()
. Exceptions thrown by the action are relayed to the caller.To loop over all keys and their associated value collections, write
Multimaps.asMap(multimap).forEach((key, valueCollection) -> action())
. -
keys
Returns an immutable multiset containing all the keys in this multimap, in the same order and with the same frequencies as they appear in this multimap; to get only a single occurrence of each key, usekeySet()
. -
createKeys
ImmutableMultiset<K> createKeys()- Specified by:
createKeys
in classAbstractMultimap<K,
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. -
createValues
ImmutableCollection<V> createValues()- Specified by:
createValues
in classAbstractMultimap<K,
V>
-
valueIterator
UnmodifiableIterator<V> valueIterator()- Overrides:
valueIterator
in classAbstractMultimap<K,
V>
-