@GwtCompatible(emulated=true) public abstract class ImmutableMultimap<K,V> extends java.lang.Object implements java.io.Serializable
Multimap
. Does not permit null keys or values.
Unlike Multimaps.unmodifiableMultimap(Multimap)
, which is
a view of a separate multimap which can still change, an instance of
ImmutableMultimap
contains its own data and will never
change. ImmutableMultimap
is convenient for
public static final
multimaps ("constant multimaps") and also lets
you easily make a "defensive copy" of a multimap provided to your class by
a caller.
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.
In addition to methods defined by Multimap
, an inverse()
method is also supported.
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"). |
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 |
containsEntry(java.lang.Object key,
java.lang.Object value)
Returns
true if the multimap contains the specified key-value pair. |
boolean |
containsKey(java.lang.Object key)
Returns
true if the multimap contains any values for the specified
key. |
boolean |
containsValue(java.lang.Object value)
Returns
true if the multimap contains the specified value for any
key. |
static <K,V> ImmutableMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as
multimap . |
ImmutableCollection<java.util.Map.Entry<K,V>> |
entries()
Returns an immutable collection of all key-value pairs in the multimap.
|
boolean |
equals(java.lang.Object object)
Compares the specified object with this multimap for equality.
|
abstract ImmutableCollection<V> |
get(K key)
Returns an immutable collection of the values for the given key.
|
int |
hashCode()
Returns the hash code for this multimap.
|
abstract ImmutableMultimap<V,K> |
inverse()
Returns an immutable multimap which is the inverse of this one.
|
boolean |
isEmpty()
Returns
true if the multimap contains no key-value pairs. |
ImmutableMultiset<K> |
keys()
Returns a collection, which may contain duplicates, of all keys.
|
ImmutableSet<K> |
keySet()
Returns an immutable set of the distinct keys 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 order.
|
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 order.
|
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 order.
|
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 the multimap.
|
java.lang.String |
toString()
Returns a string representation of the multimap, generated by calling
toString on the map returned by Multimap.asMap() . |
ImmutableCollection<V> |
values()
Returns an immutable collection of the values in this multimap.
|
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
. The generated multimap's key and value orderings correspond to
the iteration ordering of the multimap.asMap()
view.
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@Deprecated public ImmutableCollection<V> removeAll(java.lang.Object key)
removeAll
in interface Multimap<K,V>
key
- key of entries to remove from the multimapjava.lang.UnsupportedOperationException
- always@Deprecated public ImmutableCollection<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
replaceValues
in interface Multimap<K,V>
key
- key to store in the multimapvalues
- values to store in the multimapjava.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>
key
- key to store in the multimapvalue
- value to store in the multimaptrue
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)
public boolean containsKey(@Nullable java.lang.Object key)
Multimap
true
if the multimap contains any values for the specified
key.containsKey
in interface Multimap<K,V>
key
- key to search for in multimappublic int size()
Multimap
public ImmutableSet<K> keySet()
public ImmutableMap<K,java.util.Collection<V>> asMap()
public ImmutableCollection<java.util.Map.Entry<K,V>> entries()
public ImmutableMultiset<K> keys()
public ImmutableCollection<V> values()
public boolean isEmpty()
Multimap
true
if the multimap contains no key-value pairs.public boolean containsValue(@Nullable java.lang.Object value)
Multimap
true
if the multimap contains the specified value for any
key.containsValue
in interface Multimap<K,V>
value
- value to search for in multimappublic boolean containsEntry(@Nullable java.lang.Object key, @Nullable java.lang.Object value)
Multimap
true
if the multimap contains the specified key-value pair.containsEntry
in interface Multimap<K,V>
key
- key to search for in multimapvalue
- value to search for in multimappublic boolean equals(@Nullable java.lang.Object object)
Multimap
Multimap.asMap()
,
are also equal.
In general, two multimaps with identical key-value mappings may or may
not be equal, depending on the implementation. For example, two
SetMultimap
instances with the same key-value mappings are equal,
but equality of two ListMultimap
instances depends on the ordering
of the values for each key.
A non-empty SetMultimap
cannot be equal to a non-empty
ListMultimap
, since their Multimap.asMap()
views contain unequal
collections as values. However, any two empty multimaps are equal, because
they both have empty Multimap.asMap()
views.
public int hashCode()
The hash code of a multimap is defined as the hash code of the map view,
as returned by Multimap.asMap()
.
public java.lang.String toString()
toString
on the map returned by Multimap.asMap()
.toString
in class java.lang.Object