Package com.google.common.collect
Class ImmutableListMultimap<K,V>
- java.lang.Object
-
- com.google.common.collect.AbstractMultimap<K,V>
-
- com.google.common.collect.BaseImmutableMultimap<K,V>
-
- com.google.common.collect.ImmutableMultimap<K,V>
-
- com.google.common.collect.ImmutableListMultimap<K,V>
-
- All Implemented Interfaces:
ListMultimap<K,V>
,Multimap<K,V>
,java.io.Serializable
- Direct Known Subclasses:
EmptyImmutableListMultimap
public class ImmutableListMultimap<K,V> extends ImmutableMultimap<K,V> implements ListMultimap<K,V>
AListMultimap
whose contents will never change, with many other important properties detailed atImmutableCollection
.See the Guava User Guide article on immutable collections.
- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableListMultimap.Builder<K,V>
A builder for creating immutableListMultimap
instances, especiallypublic static final
multimaps ("constant multimaps").-
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableMultimap
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys
-
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries, AbstractMultimap.EntrySet
-
-
Field Summary
Fields Modifier and Type Field Description private ImmutableListMultimap<V,K>
inverse
private static long
serialVersionUID
-
Fields inherited from class com.google.common.collect.ImmutableMultimap
map, size
-
-
Constructor Summary
Constructors Constructor Description ImmutableListMultimap(ImmutableMap<K,ImmutableList<V>> map, int size)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <K,V>
ImmutableListMultimap.Builder<K,V>builder()
Returns a new builder.static <K,V>
ImmutableListMultimap<K,V>copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings asmultimap
.static <K,V>
ImmutableListMultimap<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 <T,K,V>
java.util.stream.Collector<T,?,ImmutableListMultimap<K,V>>flatteningToImmutableListMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends V>> valuesFunction)
Returns aCollector
accumulating entries into anImmutableListMultimap
.(package private) static <K,V>
ImmutableListMultimap<K,V>fromMapEntries(java.util.Collection<? extends java.util.Map.Entry<? extends K,? extends java.util.Collection<? extends V>>> mapEntries, java.util.Comparator<? super V> valueComparator)
Creates an ImmutableListMultimap from an asMap.entrySet.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.private ImmutableListMultimap<V,K>
invert()
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.private void
readObject(java.io.ObjectInputStream stream)
ImmutableList<V>
removeAll(java.lang.Object key)
Deprecated.Unsupported operation.ImmutableList<V>
replaceValues(K key, java.lang.Iterable<? extends V> values)
Deprecated.Unsupported operation.static <T,K,V>
java.util.stream.Collector<T,?,ImmutableListMultimap<K,V>>toImmutableListMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableListMultimap
whose keys and values are the result of applying the provided mapping functions to the input elements.private void
writeObject(java.io.ObjectOutputStream stream)
-
Methods inherited from class com.google.common.collect.ImmutableMultimap
asMap, clear, containsKey, containsValue, createAsMap, createEntries, createKeys, createKeySet, createValues, entries, entryIterator, entrySpliterator, forEach, isPartialView, keys, keySet, put, putAll, putAll, remove, size, valueIterator, values
-
Methods inherited from class com.google.common.collect.AbstractMultimap
containsEntry, equals, hashCode, isEmpty, toString, valueSpliterator
-
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
-
-
-
-
Field Detail
-
inverse
private transient ImmutableListMultimap<V,K> inverse
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ImmutableListMultimap
ImmutableListMultimap(ImmutableMap<K,ImmutableList<V>> map, int size)
-
-
Method Detail
-
toImmutableListMultimap
public static <T,K,V> java.util.stream.Collector<T,?,ImmutableListMultimap<K,V>> toImmutableListMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableListMultimap
whose keys and values are the result of applying the provided mapping functions to the input elements.For streams with defined encounter order (as defined in the Ordering section of the
java.util.stream
Javadoc), that order is preserved, but entries are grouped by key.Example:
static final Multimap<Character, String> FIRST_LETTER_MULTIMAP = Stream.of("banana", "apple", "carrot", "asparagus", "cherry") .collect(toImmutableListMultimap(str -> str.charAt(0), str -> str.substring(1))); // is equivalent to static final Multimap<Character, String> FIRST_LETTER_MULTIMAP = new ImmutableListMultimap.Builder<Character, String>() .put('b', "anana") .putAll('a', "pple", "sparagus") .putAll('c', "arrot", "herry") .build();
- Since:
- 21.0
-
flatteningToImmutableListMultimap
public static <T,K,V> java.util.stream.Collector<T,?,ImmutableListMultimap<K,V>> flatteningToImmutableListMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends V>> valuesFunction)
Returns aCollector
accumulating entries into anImmutableListMultimap
. Each input element is mapped to a key and a stream of values, each of which are put into the resultingMultimap
, in the encounter order of the stream and the encounter order of the streams of values.Example:
static final ImmutableListMultimap<Character, Character> FIRST_LETTER_MULTIMAP = Stream.of("banana", "apple", "carrot", "asparagus", "cherry") .collect( flatteningToImmutableListMultimap( str -> str.charAt(0), str -> str.substring(1).chars().mapToObj(c -> (char) c)); // is equivalent to static final ImmutableListMultimap<Character, Character> FIRST_LETTER_MULTIMAP = ImmutableListMultimap.<Character, Character>builder() .putAll('b', Arrays.asList('a', 'n', 'a', 'n', 'a')) .putAll('a', Arrays.asList('p', 'p', 'l', 'e')) .putAll('c', Arrays.asList('a', 'r', 'r', 'o', 't')) .putAll('a', Arrays.asList('s', 'p', 'a', 'r', 'a', 'g', 'u', 's')) .putAll('c', Arrays.asList('h', 'e', 'r', 'r', 'y')) .build();
}- Since:
- 21.0
-
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 theImmutableListMultimap.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 asmultimap
. The generated multimap's key and value orderings correspond to the iteration ordering of themultimap.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:
java.lang.NullPointerException
- if any key or value inmultimap
is null
-
copyOf
public static <K,V> ImmutableListMultimap<K,V> copyOf(java.lang.Iterable<? extends java.util.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.- Throws:
java.lang.NullPointerException
- if any key, value, or entry is null- Since:
- 19.0
-
fromMapEntries
static <K,V> ImmutableListMultimap<K,V> fromMapEntries(java.util.Collection<? extends java.util.Map.Entry<? extends K,? extends java.util.Collection<? extends V>>> mapEntries, java.util.Comparator<? super V> valueComparator)
Creates an ImmutableListMultimap from an asMap.entrySet.
-
get
public ImmutableList<V> get(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.
-
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 theImmutableMultimap
specified in theImmutableMultimap
class.- Specified by:
inverse
in classImmutableMultimap<K,V>
- Since:
- 11.0
-
invert
private ImmutableListMultimap<V,K> invert()
-
removeAll
@Deprecated public ImmutableList<V> removeAll(java.lang.Object key)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
removeAll
in interfaceListMultimap<K,V>
- Specified by:
removeAll
in interfaceMultimap<K,V>
- Overrides:
removeAll
in classImmutableMultimap<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:
java.lang.UnsupportedOperationException
- always
-
replaceValues
@Deprecated public ImmutableList<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the multimap unmodified.- Specified by:
replaceValues
in interfaceListMultimap<K,V>
- Specified by:
replaceValues
in interfaceMultimap<K,V>
- Overrides:
replaceValues
in classImmutableMultimap<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:
java.lang.UnsupportedOperationException
- always
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-