public class ImmutableListMultimap<K,V> extends ImmutableMultimap<K,V> implements ListMultimap<K,V>
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"). |
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys
AbstractMultimap.Entries, AbstractMultimap.EntrySet
Modifier and Type | Field and Description |
---|---|
private ImmutableListMultimap<V,K> |
inverse |
private static long |
serialVersionUID |
map, size
Constructor and Description |
---|
ImmutableListMultimap(ImmutableMap<K,ImmutableList<V>> map,
int size) |
Modifier and Type | Method and Description |
---|---|
static <K,V> ImmutableListMultimap.Builder<K,V> |
builder()
Returns a new builder.
|
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 <K,V> ImmutableListMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as
multimap . |
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 a
Collector accumulating entries into an ImmutableListMultimap . |
(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 a
Collector that accumulates elements into an ImmutableListMultimap
whose keys and values are the result of applying the provided mapping functions to the input
elements. |
private void |
writeObject(java.io.ObjectOutputStream stream) |
asMap, clear, containsKey, containsValue, createAsMap, createEntries, createKeys, createKeySet, createValues, entries, entryIterator, entrySpliterator, forEach, isPartialView, keys, keySet, put, putAll, putAll, remove, size, valueIterator, values
containsEntry, equals, hashCode, isEmpty, toString, valueSpliterator
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asMap, equals
private transient ImmutableListMultimap<V,K> inverse
private static final long serialVersionUID
ImmutableListMultimap(ImmutableMap<K,ImmutableList<V>> map, int size)
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)
Collector
that accumulates elements into an ImmutableListMultimap
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();
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)
Collector
accumulating entries into an ImmutableListMultimap
. Each
input element is mapped to a key and a stream of values, each of which are put into the
resulting Multimap
, 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();
}
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.
java.lang.NullPointerException
- if any key or value in multimap
is nullpublic static <K,V> ImmutableListMultimap<K,V> copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries)
java.lang.NullPointerException
- if any key, value, or entry is nullstatic <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)
public ImmutableList<V> get(K key)
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>
private ImmutableListMultimap<V,K> invert()
@Deprecated public ImmutableList<V> removeAll(java.lang.Object key)
removeAll
in interface ListMultimap<K,V>
removeAll
in interface Multimap<K,V>
removeAll
in class ImmutableMultimap<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public ImmutableList<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
replaceValues
in interface ListMultimap<K,V>
replaceValues
in interface Multimap<K,V>
replaceValues
in class ImmutableMultimap<K,V>
java.lang.UnsupportedOperationException
- alwaysprivate void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
java.io.IOException
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException