@GwtCompatible(serializable=true, emulated=true) public class ImmutableSetMultimap<K,V> extends ImmutableMultimap<K,V> implements SetMultimap<K,V>
SetMultimap
with reliable user-specified key and value
iteration order. Does not permit null keys or values.
Unlike Multimaps.unmodifiableSetMultimap(SetMultimap)
, which is
a view of a separate multimap which can still change, an instance of
ImmutableSetMultimap
contains its own data and will never
change. ImmutableSetMultimap
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.
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.BuilderMultimap<K,V>
Multimap for
ImmutableSetMultimap.Builder that maintains key
and value orderings and performs better than LinkedHashMultimap . |
private static class |
ImmutableSetMultimap.EntrySet<K,V> |
ImmutableMultimap.FieldSettersHolder, ImmutableMultimap.Keys
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(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.
|
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.
|
(package private) 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, createValues, entryIterator, isPartialView, keys, keySet, put, putAll, putAll, remove, size, valueIterator, values
containsEntry, createKeySet, equals, hashCode, isEmpty, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asMap, equals
clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
private final transient ImmutableSet<V> emptySet
private transient ImmutableSetMultimap<V,K> inverse
private transient ImmutableSet<java.util.Map.Entry<K,V>> entries
@GwtIncompatible(value="not needed in emulated source.") private static final long serialVersionUID
ImmutableSetMultimap(ImmutableMap<K,ImmutableSet<V>> map, int size, @Nullable java.util.Comparator<? super V> valueComparator)
public static <K,V> ImmutableSetMultimap<K,V> of()
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, java.util.Comparator<? super V> valueComparator)
public ImmutableSet<V> get(@Nullable 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 ImmutableSet<V> removeAll(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 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(@Nullable java.util.Comparator<? super V> valueComparator, java.util.Collection<? extends V> values)
private static <V> ImmutableSet<V> emptySet(@Nullable java.util.Comparator<? super V> valueComparator)
@GwtIncompatible(value="java.io.ObjectOutputStream") private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
java.io.IOException
@Nullable java.util.Comparator<? super V> valueComparator()
@GwtIncompatible(value="java.io.ObjectInputStream") private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException