Top Description Methods
com.google.common.collect

public Interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

extends Multimap<K extends @Nullable Object, V extends @Nullable Object>
Known Direct Subinterfaces
com.google.common.collect.SortedSetMultimap, com.google.common.collect.FilteredSetMultimap
Known Direct Implementers
com.google.common.collect.Synchronized.SynchronizedSetMultimap, com.google.common.collect.AbstractSetMultimap, com.google.common.collect.ForwardingSetMultimap, com.google.common.collect.ImmutableSetMultimap, com.google.common.collect.Multimaps.UnmodifiableSetMultimap, com.google.common.collect.Multimaps.MapMultimap
Annotations
@GwtCompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtCompatible, com.google.errorprone.annotations.CanIgnoreReturnValue, java.util.Collection, .Map, .Map.Entry, .Set, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable
A Multimap that cannot hold duplicate key-value pairs. Adding a key-value pair that's already in the multimap has no effect. See the Multimap documentation for information common to all multimaps.

The get, removeAll, and replaceValues methods each return a Set of values, while entries returns a Set of map entries. Though the method signature doesn't say so explicitly, the map returned by asMap has Set values.

If the values corresponding to a single key should be ordered according to a java.util.Comparator (or the natural order), see the SortedSetMultimap subinterface.

Since the value collections are sets, the behavior of a SetMultimap is not specified if key or value objects already present in the multimap change in a manner that affects equals comparisons. Use caution if mutable objects are used as keys or values in a SetMultimap.

Warning

Do not modify either a key or a value of a SetMultimap in a way that affects its Object#equals behavior. Undefined behavior and bugs will result.

See the Guava User Guide article on Multimap.

Author
Jared Levy
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public Map<K, Collection<V>>
asMap()

Redeclares com.google.common.collect.Multimap.asMap.

Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values.
public Set<Map.Entry<K, V>>
entries()

Redeclares com.google.common.collect.Multimap.entries.

Returns a view collection of all key-value pairs contained in this multimap, as Entry instances.
public boolean
equals(Object obj)

Redeclares com.google.common.collect.Multimap.equals.

Compares the specified object to this multimap for equality.
public Set<V>
get(K key)

Redeclares com.google.common.collect.Multimap.get.

Returns a view collection of the values associated with key in this multimap, if any.
public Set<V>
removeAll(Object key)

Redeclares com.google.common.collect.Multimap.removeAll.

Removes all values associated with the key key.
public Set<V>
replaceValues(K key, Iterable<? extends V> values)

Redeclares com.google.common.collect.Multimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.
Inherited from com.google.common.collect.Multimap:
clearcontainsEntrycontainsKeycontainsValueforEachhashCodeisEmptykeyskeySetputputAllputAllremovesizevalues

Method Detail

asMapback to summary
public Map<K, Collection<V>> asMap()

Redeclares com.google.common.collect.Multimap.asMap.

Doc from com.google.common.collect.Multimap.asMap.

Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values. Note that this.asMap().get(k) is equivalent to this.get(k) only when k is a key contained in the multimap; otherwise it returns null as opposed to an empty collection.

Changes to the returned map or the collections that serve as its values will update the underlying multimap, and vice versa. The map does not support put or putAll, nor do its entries support setValue.

Note

The returned map's values are guaranteed to be of type Set. To obtain this map with the more specific generic type Map<K, Set<V>>, call Multimaps#asMap(SetMultimap) instead.

Annotations
@Override
entriesback to summary
public Set<Map.Entry<K, V>> entries()

Redeclares com.google.common.collect.Multimap.entries.

Doc from com.google.common.collect.Multimap.entries.

Returns a view collection of all key-value pairs contained in this multimap, as Entry instances.

Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

Because a SetMultimap has unique values for a given key, this method returns a Set, instead of the java.util.Collection specified in the Multimap interface.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Redeclares com.google.common.collect.Multimap.equals.

Compares the specified object to this multimap for equality.

Two SetMultimap instances are equal if, for each key, they contain the same values. Equality does not depend on the ordering of keys or values.

An empty SetMultimap is equal to any other empty Multimap, including an empty ListMultimap.

Annotations
@Override
getback to summary
public Set<V> get(K key)

Redeclares com.google.common.collect.Multimap.get.

Doc from com.google.common.collect.Multimap.get.

Returns a view collection of the values associated with key in this multimap, if any. Note that when containsKey(key) is false, this returns an empty collection, not null.

Changes to the returned collection will update the underlying multimap, and vice versa.

Because a SetMultimap has unique values for a given key, this method returns a Set, instead of the java.util.Collection specified in the Multimap interface.

Annotations
@Override
removeAllback to summary
public Set<V> removeAll(Object key)

Redeclares com.google.common.collect.Multimap.removeAll.

Doc from com.google.common.collect.Multimap.removeAll.

Removes all values associated with the key key.

Once this method returns, key will not be mapped to any values, so it will not appear in keySet(), asMap(), or any other views.

Because a SetMultimap has unique values for a given key, this method returns a Set, instead of the java.util.Collection specified in the Multimap interface.

Returns:Set<V>

the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

Annotations
@CanIgnoreReturnValue
@Override
replaceValuesback to summary
public Set<V> replaceValues(K key, Iterable<? extends V> values)

Redeclares com.google.common.collect.Multimap.replaceValues.

Doc from com.google.common.collect.Multimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.

If values is empty, this is equivalent to removeAll(key).

Because a SetMultimap has unique values for a given key, this method returns a Set, instead of the java.util.Collection specified in the Multimap interface.

Any duplicates in values will be stored in the multimap once.

Returns:Set<V>

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.

Annotations
@CanIgnoreReturnValue
@Override