public class ImmutableSetMultimap<K,V> extends ImmutableMultimap<K,V> implements SetMultimap<K,V>
SetMultimap
whose contents will never change, with many other important properties
detailed at ImmutableCollection
.
Warning: As in all SetMultimap
s, do not modify either a key or a value
of a ImmutableSetMultimap
in a way that affects its Object.equals(java.lang.Object)
behavior.
Undefined behavior and bugs will result.
See the Guava User Guide article on immutable collections.
Modifier and Type | Class and Description |
---|---|
static class |
ImmutableSetMultimap.Builder<K,V>
A builder for creating immutable
SetMultimap instances, especially public static
final multimaps ("constant multimaps"). |
private static class |
ImmutableSetMultimap.EntrySet<K,V> |
private static class |
ImmutableSetMultimap.SetFieldSettersHolder |
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys
AbstractMultimap.Entries
Modifier and Type | Field and Description |
---|---|
private ImmutableSet<V> |
emptySet
Returned by get() when a missing key is provided.
|
private ImmutableSet<java.util.Map.Entry<K,V>> |
entries |
private ImmutableSetMultimap<V,K> |
inverse |
private static long |
serialVersionUID |
map, size
Constructor and Description |
---|
ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map,
int size,
java.util.Comparator<? super V> valueComparator) |
Modifier and Type | Method and Description |
---|---|
static <K,V> ImmutableSetMultimap.Builder<K,V> |
builder()
Returns a new
ImmutableSetMultimap.Builder . |
static <K,V> ImmutableSetMultimap<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> ImmutableSetMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable set multimap containing the same mappings as
multimap . |
private static <K,V> ImmutableSetMultimap<K,V> |
copyOf(Multimap<? extends K,? extends V> multimap,
java.util.Comparator<? super V> valueComparator) |
private static <V> ImmutableSet<V> |
emptySet(java.util.Comparator<? super V> valueComparator) |
ImmutableSet<java.util.Map.Entry<K,V>> |
entries()
Returns an immutable collection of all key-value pairs in the multimap.
|
static <T,K,V> java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>> |
flatteningToImmutableSetMultimap(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 ImmutableSetMultimap . |
(package private) static <K,V> ImmutableSetMultimap<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 ImmutableSetMultimap from an asMap.entrySet.
|
ImmutableSet<V> |
get(K key)
Returns an immutable set of the values for the given key.
|
ImmutableSetMultimap<V,K> |
inverse()
Returns an immutable multimap which is the inverse of this one.
|
private ImmutableSetMultimap<V,K> |
invert() |
static <K,V> ImmutableSetMultimap<K,V> |
of()
Returns the empty multimap.
|
static <K,V> ImmutableSetMultimap<K,V> |
of(K k1,
V v1)
Returns an immutable multimap containing a single entry.
|
static <K,V> ImmutableSetMultimap<K,V> |
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable multimap containing the given entries, in order.
|
static <K,V> ImmutableSetMultimap<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> ImmutableSetMultimap<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> ImmutableSetMultimap<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) |
ImmutableSet<V> |
removeAll(java.lang.Object key)
Deprecated.
Unsupported operation.
|
ImmutableSet<V> |
replaceValues(K key,
java.lang.Iterable<? extends V> values)
Deprecated.
Unsupported operation.
|
static <T,K,V> java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>> |
toImmutableSetMultimap(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 ImmutableSetMultimap
whose keys and values are the result of applying the provided mapping functions to the input
elements. |
(package private) java.util.Comparator<? super V> |
valueComparator() |
private static <V> ImmutableSet.Builder<V> |
valuesBuilder(java.util.Comparator<? super V> valueComparator) |
private static <V> ImmutableSet<V> |
valueSet(java.util.Comparator<? super V> valueComparator,
java.util.Collection<? extends V> values) |
private void |
writeObject(java.io.ObjectOutputStream stream) |
asMap, clear, containsKey, containsValue, createAsMap, createEntries, createKeys, createKeySet, createValues, 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 final transient ImmutableSet<V> emptySet
@CheckForNull private transient ImmutableSetMultimap<V,K> inverse
@CheckForNull private transient ImmutableSet<java.util.Map.Entry<K,V>> entries
private static final long serialVersionUID
ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map, int size, @CheckForNull java.util.Comparator<? super V> valueComparator)
public static <T,K,V> java.util.stream.Collector<T,?,ImmutableSetMultimap<K,V>> toImmutableSetMultimap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Collector
that accumulates elements into an ImmutableSetMultimap
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(toImmutableSetMultimap(str -> str.charAt(0), str -> str.substring(1)));
// is equivalent to
static final Multimap<Character, String> FIRST_LETTER_MULTIMAP =
new ImmutableSetMultimap.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,?,ImmutableSetMultimap<K,V>> flatteningToImmutableSetMultimap(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 ImmutableSetMultimap
. 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 ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
Stream.of("banana", "apple", "carrot", "asparagus", "cherry")
.collect(
flatteningToImmutableSetMultimap(
str -> str.charAt(0),
str -> str.substring(1).chars().mapToObj(c -> (char) c));
// is equivalent to
static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
ImmutableSetMultimap.<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();
// after deduplication, the resulting multimap is equivalent to
static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
ImmutableSetMultimap.<Character, Character>builder()
.putAll('b', Arrays.asList('a', 'n'))
.putAll('a', Arrays.asList('p', 'l', 'e', 's', 'a', 'r', 'g', 'u'))
.putAll('c', Arrays.asList('a', 'r', 'o', 't', 'h', 'e', 'y'))
.build();
}
public static <K,V> ImmutableSetMultimap<K,V> of()
Performance note: the instance returned is a singleton.
public static <K,V> ImmutableSetMultimap<K,V> of(K k1, V v1)
public static <K,V> ImmutableSetMultimap<K,V> of(K k1, V v1, K k2, V v2)
Object.equals(java.lang.Object)
) after the first are ignored.public static <K,V> ImmutableSetMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
Object.equals(java.lang.Object)
) after the first are ignored.public static <K,V> ImmutableSetMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
Object.equals(java.lang.Object)
) after the first are ignored.public static <K,V> ImmutableSetMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
Object.equals(java.lang.Object)
) after the first are ignored.public static <K,V> ImmutableSetMultimap.Builder<K,V> builder()
ImmutableSetMultimap.Builder
.public static <K,V> ImmutableSetMultimap<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. Repeated occurrences of an entry in the multimap after the first are
ignored.
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 nullprivate static <K,V> ImmutableSetMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap, @CheckForNull java.util.Comparator<? super V> valueComparator)
public static <K,V> ImmutableSetMultimap<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> ImmutableSetMultimap<K,V> fromMapEntries(java.util.Collection<? extends java.util.Map.Entry<? extends K,? extends java.util.Collection<? extends V>>> mapEntries, @CheckForNull java.util.Comparator<? super V> valueComparator)
public ImmutableSet<V> get(K key)
public ImmutableSetMultimap<V,K> inverse()
Because an inverse of a set multimap cannot contain multiple pairs with the same key and
value, this method returns an ImmutableSetMultimap
rather than the ImmutableMultimap
specified in the ImmutableMultimap
class.
inverse
in class ImmutableMultimap<K,V>
private ImmutableSetMultimap<V,K> invert()
@Deprecated public final ImmutableSet<V> removeAll(@CheckForNull java.lang.Object key)
removeAll
in interface Multimap<K,V>
removeAll
in interface SetMultimap<K,V>
removeAll
in class ImmutableMultimap<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public final ImmutableSet<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
replaceValues
in interface Multimap<K,V>
replaceValues
in interface SetMultimap<K,V>
replaceValues
in class ImmutableMultimap<K,V>
java.lang.UnsupportedOperationException
- alwayspublic ImmutableSet<java.util.Map.Entry<K,V>> entries()
private static <V> ImmutableSet<V> valueSet(@CheckForNull java.util.Comparator<? super V> valueComparator, java.util.Collection<? extends V> values)
private static <V> ImmutableSet<V> emptySet(@CheckForNull java.util.Comparator<? super V> valueComparator)
private static <V> ImmutableSet.Builder<V> valuesBuilder(@CheckForNull java.util.Comparator<? super V> valueComparator)
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
java.io.IOException
@CheckForNull java.util.Comparator<? super V> valueComparator()
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException