com.google.common.collect

Class ImmutableListMultimap<K,V>

java.lang.Object

com.google.common.collect.ImmutableMultimap<K,V>

com.google.common.collect.ImmutableListMultimap<K,V>

All Implemented Interfaces:

ListMultimap<K,V>, Multimap<K,V>, Serializable

@GwtCompatible(serializable=true,
               emulated=true)
public class ImmutableListMultimap<K,V>
extends ImmutableMultimap<K,V>
implements ListMultimap<K,V>

An immutable ListMultimap with reliable user-specified key and value iteration order. Does not permit null keys or values.

Unlike Multimaps.unmodifiableListMultimap(ListMultimap), which is a view of a separate multimap which can still change, an instance of ImmutableListMultimap contains its own data and will never change. ImmutableListMultimap 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.

See the Guava User Guide article on immutable collections.

Since:

2.0 (imported from Google Collections Library)

Author:

Jared Levy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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").

Method Summary

Methods

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(Multimap<? extends K,? extends V> multimap) Returns an immutable multimap containing the same mappings as multimap.
boolean	equals(Object object) Indicates whether some other object is "equal to" this one.
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().

Methods inherited from class com.google.common.collect.ImmutableMultimap

asMap, clear, containsKey, containsValue, entries, keys, keySet, put, putAll, putAll, remove, size, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.collect.ListMultimap

asMap, equals

Methods inherited from interface com.google.common.collect.Multimap

clear, containsEntry, containsKey, containsValue, entries, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values

Method Detail

of

public static <K,V> ImmutableListMultimap<K,V> of()

Returns the empty multimap.

of

public static <K,V> ImmutableListMultimap<K,V> of(K k1,
                                  V v1)

Returns an immutable multimap containing a single entry.

of

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.

of

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.

of

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.

of

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.

builder

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.

copyOf

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.

Throws:

NullPointerException - if any key or value in multimap is null

get

public 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.

Specified by:

get in interface ListMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Specified by:

get in class ImmutableMultimap<K,V>

inverse

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.

Specified by:

inverse in class ImmutableMultimap<K,V>

Since:

11.0

removeAll

@Deprecated
public ImmutableList<V> removeAll(Object key)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the multimap unmodified.

Specified by:

removeAll in interface ListMultimap<K,V>

Specified by:

removeAll in interface Multimap<K,V>

Overrides:

removeAll in class ImmutableMultimap<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
public ImmutableList<V> replaceValues(K key,
                                        Iterable<? extends V> values)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the multimap unmodified.

Specified by:

replaceValues in interface ListMultimap<K,V>

Specified by:

replaceValues in interface Multimap<K,V>

Overrides:

replaceValues in class ImmutableMultimap<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

isEmpty

public boolean isEmpty()

Description copied from interface: Multimap

Returns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.

Specified by:

isEmpty in interface Multimap<K,V>

containsEntry

public boolean containsEntry(@Nullable
                    Object key,
                    @Nullable
                    Object value)

Description copied from interface: Multimap

Returns true if this multimap contains at least one key-value pair with the key key and the value value.

Specified by:

containsEntry in interface Multimap<K,V>

equals

public boolean equals(@Nullable
             Object object)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface Multimap<K,V>

Overrides:

equals in class Object

Parameters:

object - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns the hash code for this multimap.

The hash code of a multimap is defined as the hash code of the map view, as returned by Multimap.asMap().

Specified by:

hashCode in interface Multimap<K,V>

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Map.hashCode()

toString

public String toString()

Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.asMap().

Overrides:

toString in class Object

Returns:

a string representation of the multimap