@GwtCompatible(emulated=true) public abstract class ImmutableMultimap<K,V> extends BaseImmutableMultimap<K,V> implements java.io.Serializable
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.
Modifier and Type | Class and Description |
---|---|
static class |
ImmutableMultimap.Builder<K,V>
A builder for creating immutable multimap instances, especially
public static final
multimaps ("constant multimaps"). |
private static class |
ImmutableMultimap.EntryCollection<K,V> |
(package private) static class |
ImmutableMultimap.FieldSettersHolder |
(package private) class |
ImmutableMultimap.Keys |
private static class |
ImmutableMultimap.KeysSerializedForm |
private static class |
ImmutableMultimap.Values<K,V> |
AbstractMultimap.Entries, AbstractMultimap.EntrySet
Modifier and Type | Field and Description |
---|---|
(package private) ImmutableMap<K,? extends ImmutableCollection<V>> |
map |
private static long |
serialVersionUID |
(package private) int |
size |
Constructor and Description |
---|
ImmutableMultimap(ImmutableMap<K,? extends ImmutableCollection<V>> map,
int size) |
Modifier and Type | Method and Description |
---|---|
ImmutableMap<K,java.util.Collection<V>> |
asMap()
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.
|
void |
clear()
Deprecated.
Unsupported operation.
|
boolean |
containsKey(java.lang.Object key)
Returns
true if this multimap contains at least one key-value pair with the key key . |
boolean |
containsValue(java.lang.Object value)
Returns
true if this multimap contains at least one key-value pair with the value
value . |
static <K,V> ImmutableMultimap<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> ImmutableMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as
multimap , in the
"key-grouped" iteration order described in the class documentation. |
(package private) java.util.Map<K,java.util.Collection<V>> |
createAsMap() |
(package private) ImmutableCollection<java.util.Map.Entry<K,V>> |
createEntries() |
(package private) ImmutableMultiset<K> |
createKeys() |
(package private) java.util.Set<K> |
createKeySet() |
(package private) ImmutableCollection<V> |
createValues() |
ImmutableCollection<java.util.Map.Entry<K,V>> |
entries()
Returns an immutable collection of all key-value pairs in the multimap.
|
(package private) UnmodifiableIterator<java.util.Map.Entry<K,V>> |
entryIterator() |
(package private) java.util.Spliterator<java.util.Map.Entry<K,V>> |
entrySpliterator() |
void |
forEach(java.util.function.BiConsumer<? super K,? super V> action)
Performs the given action for all key-value pairs contained in this multimap.
|
abstract ImmutableCollection<V> |
get(K key)
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 |
isPartialView()
Returns
true if this immutable multimap's implementation contains references to
user-created objects that aren't accessible via this multimap's methods. |
ImmutableMultiset<K> |
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, use
keySet() . |
ImmutableSet<K> |
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.
|
boolean |
put(K key,
V value)
Deprecated.
Unsupported operation.
|
boolean |
putAll(K key,
java.lang.Iterable<? extends V> values)
Deprecated.
Unsupported operation.
|
boolean |
putAll(Multimap<? extends K,? extends V> multimap)
Deprecated.
Unsupported operation.
|
boolean |
remove(java.lang.Object key,
java.lang.Object value)
Deprecated.
Unsupported operation.
|
ImmutableCollection<V> |
removeAll(java.lang.Object key)
Deprecated.
Unsupported operation.
|
ImmutableCollection<V> |
replaceValues(K key,
java.lang.Iterable<? extends V> values)
Deprecated.
Unsupported operation.
|
int |
size()
Returns the number of key-value pairs in this multimap.
|
(package private) UnmodifiableIterator<V> |
valueIterator() |
ImmutableCollection<V> |
values()
Returns an immutable collection of the values in this multimap.
|
containsEntry, equals, hashCode, isEmpty, toString, valueSpliterator
final transient ImmutableMap<K,? extends ImmutableCollection<V>> map
final transient int size
private static final long serialVersionUID
ImmutableMultimap(ImmutableMap<K,? extends ImmutableCollection<V>> map, int size)
public static <K,V> ImmutableMultimap<K,V> of()
public static <K,V> ImmutableMultimap<K,V> of(K k1, V v1)
public static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2)
public static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
public static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
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)
public static <K,V> ImmutableMultimap.Builder<K,V> builder()
ImmutableMultimap.Builder
constructor.public static <K,V> ImmutableMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
multimap
, 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.
java.lang.NullPointerException
- if any key or value in multimap
is null@Beta public static <K,V> ImmutableMultimap<K,V> copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries)
java.lang.NullPointerException
- if any key, value, or entry is null@Deprecated public ImmutableCollection<V> removeAll(java.lang.Object key)
@Deprecated public ImmutableCollection<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
replaceValues
in interface Multimap<K,V>
replaceValues
in class AbstractMultimap<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public void clear()
public abstract ImmutableCollection<V> get(K key)
public abstract ImmutableMultimap<V,K> inverse()
@Deprecated public boolean put(K key, V value)
put
in interface Multimap<K,V>
put
in class AbstractMultimap<K,V>
true
if the method increased the size of the multimap, or false
if the
multimap already contained the key-value pair and doesn't allow duplicatesjava.lang.UnsupportedOperationException
- always@Deprecated public boolean putAll(K key, java.lang.Iterable<? extends V> values)
@Deprecated public boolean putAll(Multimap<? extends K,? extends V> multimap)
@Deprecated public boolean remove(java.lang.Object key, java.lang.Object value)
boolean isPartialView()
true
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 whether copyOf
implementations should make an explicit copy to avoid
memory leaks.public boolean containsKey(java.lang.Object key)
Multimap
true
if this multimap contains at least one key-value pair with the key key
.containsKey
in interface Multimap<K,V>
public boolean containsValue(java.lang.Object value)
Multimap
true
if this multimap contains at least one key-value pair with the value
value
.containsValue
in interface Multimap<K,V>
containsValue
in class AbstractMultimap<K,V>
public int size()
Multimap
Note: this method does not return the number of distinct keys in the multimap,
which is given by keySet().size()
or asMap().size()
. See the opening section of
the Multimap
class documentation for clarification.
public ImmutableSet<K> keySet()
java.util.Set<K> createKeySet()
createKeySet
in class AbstractMultimap<K,V>
public ImmutableMap<K,java.util.Collection<V>> asMap()
java.util.Map<K,java.util.Collection<V>> createAsMap()
createAsMap
in class AbstractMultimap<K,V>
public ImmutableCollection<java.util.Map.Entry<K,V>> entries()
ImmutableCollection<java.util.Map.Entry<K,V>> createEntries()
createEntries
in class AbstractMultimap<K,V>
UnmodifiableIterator<java.util.Map.Entry<K,V>> entryIterator()
entryIterator
in class AbstractMultimap<K,V>
java.util.Spliterator<java.util.Map.Entry<K,V>> entrySpliterator()
entrySpliterator
in class AbstractMultimap<K,V>
public void forEach(java.util.function.BiConsumer<? super K,? super V> action)
Multimap
Multimap
implementation, actions will be performed in the order of
iteration of Multimap.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())
.
public ImmutableMultiset<K> keys()
keySet()
.ImmutableMultiset<K> createKeys()
createKeys
in class AbstractMultimap<K,V>
public ImmutableCollection<V> values()
ImmutableCollection<V> createValues()
createValues
in class AbstractMultimap<K,V>
UnmodifiableIterator<V> valueIterator()
valueIterator
in class AbstractMultimap<K,V>