|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableMultimap<K,V>
com.google.common.collect.ImmutableListMultimap<K,V>
@GwtCompatible(serializable=true,
emulated=true)
public class ImmutableListMultimap<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.
| Nested Class Summary | |
|---|---|
static class |
ImmutableListMultimap.Builder<K,V>
A builder for creating immutable ListMultimap instances, especially
public static final multimaps ("constant multimaps"). |
| Method Summary | ||
|---|---|---|
static
|
builder()
Returns a new builder. |
|
static
|
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as multimap. |
|
ImmutableList<V> |
get(K key)
Returns an immutable list of the values for the given key. |
|
ImmutableListMultimap<V,K> |
inverse()
Returns an immutable multimap which is the inverse of this one. |
|
static
|
of()
Returns the empty multimap. |
|
static
|
of(K k1,
V v1)
Returns an immutable multimap containing a single entry. |
|
static
|
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable multimap containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
Returns an immutable multimap containing the given entries, in order. |
|
static
|
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
|
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)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
ImmutableList<V> |
replaceValues(K key,
Iterable<? extends V> values)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
| Methods inherited from class com.google.common.collect.ImmutableMultimap |
|---|
asMap, clear, containsEntry, containsKey, containsValue, entries, equals, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, toString, 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 |
|---|
public static <K,V> ImmutableListMultimap<K,V> of()
public static <K,V> ImmutableListMultimap<K,V> of(K k1,
V v1)
public static <K,V> ImmutableListMultimap<K,V> of(K k1,
V v1,
K k2,
V v2)
public static <K,V> ImmutableListMultimap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
public static <K,V> ImmutableListMultimap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4)
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)
public static <K,V> ImmutableListMultimap.Builder<K,V> builder()
ImmutableListMultimap.Builder constructor.
public static <K,V> ImmutableListMultimap<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.
NullPointerException - if any key or value in multimap is
null
public ImmutableList<V> get(@Nullable
K key)
get in interface ListMultimap<K,V>get in interface Multimap<K,V>get in class ImmutableMultimap<K,V>key - key to search for in multimap
@Beta public ImmutableListMultimap<V,K> inverse()
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>public ImmutableList<V> removeAll(Object key)
removeAll in interface ListMultimap<K,V>removeAll in interface Multimap<K,V>removeAll in class ImmutableMultimap<K,V>key - key of entries to remove from the multimap
UnsupportedOperationException - always
public ImmutableList<V> replaceValues(K key,
Iterable<? extends V> values)
replaceValues in interface ListMultimap<K,V>replaceValues in interface Multimap<K,V>replaceValues in class ImmutableMultimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
UnsupportedOperationException - always
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||