@GwtCompatible(serializable=true, emulated=true) public class ImmutableListMultimap<K,V> extends ImmutableMultimap<K,V> implements ListMultimap<K,V>
A ListMultimap whose contents will never change, with many other important properties detailed at ImmutableCollection.
See the Guava User Guide article on immutable collections.
| Modifier and Type | Class and Description |
|---|---|
static class |
ImmutableListMultimap.Builder<K,V>
A builder for creating immutable
ListMultimap instances, especially public static final multimaps (“constant multimaps”). |
| Modifier and Type | Method and Description |
|---|---|
static <K,V> ImmutableListMultimap.Builder<K,V> |
builder()
Returns a new builder.
|
boolean |
containsEntry(Object key,
Object value)
Returns
true if this multimap contains at least one key-value pair with the key key and the value value. |
static <K,V> ImmutableListMultimap<K,V> |
copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
Returns an immutable multimap containing the specified entries.
|
static <K,V> ImmutableListMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as
multimap. |
boolean |
equals(Object object)
Compares the specified object with this multimap for equality.
|
ImmutableList<V> |
get(K key)
Returns an immutable list of the values for the given key.
|
int |
hashCode()
Returns the hash code for this multimap.
|
ImmutableListMultimap<V,K> |
inverse()
Returns an immutable multimap which is the inverse of this one.
|
boolean |
isEmpty()
Returns
true if this multimap contains no key-value pairs. |
static <K,V> ImmutableListMultimap<K,V> |
of()
Returns the empty multimap.
|
static <K,V> ImmutableListMultimap<K,V> |
of(K k1,
V v1)
Returns an immutable multimap containing a single entry.
|
static <K,V> ImmutableListMultimap<K,V> |
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable multimap containing the given entries, in order.
|
static <K,V> ImmutableListMultimap<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> ImmutableListMultimap<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> ImmutableListMultimap<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.
|
ImmutableList<V> |
removeAll(Object key)
Deprecated.
Unsupported operation.
|
ImmutableList<V> |
replaceValues(K key,
Iterable<? extends V> values)
Deprecated.
Unsupported operation.
|
String |
toString()
Returns a string representation of the multimap, generated by calling
toString on the map returned by Multimap.asMap(). |
asMap, clear, containsKey, containsValue, entries, keys, keySet, put, putAll, putAll, remove, size, valuesclone, finalize, getClass, notify, notifyAll, wait, wait, waitasMap, equalspublic static <K,V> ImmutableListMultimap<K,V> of()
Returns the empty multimap.
public static <K,V> ImmutableListMultimap<K,V> of(K k1, V v1)
Returns an immutable multimap containing a single entry.
public static <K,V> ImmutableListMultimap<K,V> of(K k1, V v1, K k2, V v2)
Returns an immutable multimap containing the given entries, in order.
public static <K,V> ImmutableListMultimap<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.
public static <K,V> ImmutableListMultimap<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.
public static <K,V> ImmutableListMultimap<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.
public static <K,V> ImmutableListMultimap.Builder<K,V> builder()
Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableListMultimap.Builder constructor.
public static <K,V> ImmutableListMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as 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.
NullPointerException - if any key or value in multimap is null@Beta public static <K,V> ImmutableListMultimap<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.
NullPointerException - if any key, value, or entry is nullpublic ImmutableList<V> get(@Nullable K key)
Returns an immutable list of the values for the given key. If no mappings in the multimap have the provided key, an empty immutable list is returned. The values are in the same order as the parameters used to build this multimap.
public ImmutableListMultimap<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 list multimap can contain multiple pairs with the same key and value, this method returns an ImmutableListMultimap rather than the ImmutableMultimap specified in the ImmutableMultimap class.
inverse in class ImmutableMultimap<K,V>@Deprecated public ImmutableList<V> removeAll(Object key)
Guaranteed to throw an exception and leave the multimap unmodified.
removeAll in interface ListMultimap<K,V>removeAll in interface Multimap<K,V>removeAll in class ImmutableMultimap<K,V>UnsupportedOperationException - always@Deprecated public ImmutableList<V> replaceValues(K key, Iterable<? extends V> values)
Guaranteed to throw an exception and leave the multimap unmodified.
replaceValues in interface ListMultimap<K,V>replaceValues in interface Multimap<K,V>replaceValues in class ImmutableMultimap<K,V>UnsupportedOperationException - alwayspublic boolean isEmpty()
MultimapReturns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.
public boolean containsEntry(@Nullable Object key, @Nullable Object value)
MultimapReturns true if this multimap contains at least one key-value pair with the key key and the value value.
containsEntry in interface Multimap<K,V>public boolean equals(@Nullable Object object)
MultimapCompares the specified object with this multimap for equality. Two multimaps are equal when their map views, as returned by 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 String toString()
toString on the map returned by Multimap.asMap().