Class AbstractSetMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,
,V> SetMultimap<K,
,V> Serializable
- Direct Known Subclasses:
AbstractSortedSetMultimap
,HashMultimapGwtSerializationDependencies
,LinkedHashMultimapGwtSerializationDependencies
,Multimaps.CustomSetMultimap
SetMultimap
interface. It's a wrapper around AbstractMapBasedMultimap
that converts the returned collections into Sets
. The createCollection()
method must return a Set
.-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMapBasedMultimap
AbstractMapBasedMultimap.WrappedCollection, AbstractMapBasedMultimap.WrappedList, AbstractMapBasedMultimap.WrappedNavigableSet, AbstractMapBasedMultimap.WrappedSet, AbstractMapBasedMultimap.WrappedSortedSet
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries, AbstractMultimap.EntrySet, AbstractMultimap.Values
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractSetMultimap
(Map<K, Collection<V>> map) Creates a new multimap that uses the provided map. -
Method Summary
Modifier and TypeMethodDescriptionMap
<K, Collection<V>> asMap()
Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values.Creates the collection of values for a single key.Creates an unmodifiable, empty collection of values.entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.boolean
Compares the specified object to this multimap for equality.Returns a view collection of the values associated withkey
in this multimap, if any.boolean
Stores a key-value pair in the multimap.Removes all values associated with the keykey
.replaceValues
(K key, Iterable<? extends V> values) Stores a collection of values with the same key, replacing any existing values for that key.(package private) <E> Collection
<E> unmodifiableCollectionSubclass
(Collection<E> collection) (package private) Collection
<V> wrapCollection
(K key, Collection<V> collection) Generates a decorated collection that remains consistent with the values in the multimap for the provided key.Methods inherited from class com.google.common.collect.AbstractMapBasedMultimap
backingMap, clear, containsKey, createAsMap, createCollection, createEntries, createKeys, createKeySet, createMaybeNavigableAsMap, createMaybeNavigableKeySet, createValues, entryIterator, entrySpliterator, forEach, setMap, size, valueIterator, values, valueSpliterator, wrapList
Methods inherited from class com.google.common.collect.AbstractMultimap
containsEntry, containsValue, hashCode, isEmpty, keys, keySet, putAll, putAll, remove, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, forEach, hashCode, isEmpty, keys, keySet, putAll, putAll, remove, size, values
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
AbstractSetMultimap
Creates a new multimap that uses the provided map.- Parameters:
map
- place to store the mapping from each key to its corresponding values
-
-
Method Details
-
createCollection
Description copied from class:AbstractMapBasedMultimap
Creates the collection of values for a single key.Collections with weak, soft, or phantom references are not supported. Each call to
createCollection
should create a new instance.The returned collection class determines whether duplicate key-value pairs are allowed.
- Specified by:
createCollection
in classAbstractMapBasedMultimap<K,
V> - Returns:
- an empty collection of values
-
createUnmodifiableEmptyCollection
Description copied from class:AbstractMapBasedMultimap
Creates an unmodifiable, empty collection of values.This is used in
AbstractMapBasedMultimap.removeAll(java.lang.Object)
on an empty key.- Overrides:
createUnmodifiableEmptyCollection
in classAbstractMapBasedMultimap<K,
V>
-
unmodifiableCollectionSubclass
- Overrides:
unmodifiableCollectionSubclass
in classAbstractMapBasedMultimap<K,
V>
-
wrapCollection
Description copied from class:AbstractMapBasedMultimap
Generates a decorated collection that remains consistent with the values in the multimap for the provided key. Changes to the multimap may alter the returned collection, and vice versa.- Overrides:
wrapCollection
in classAbstractMapBasedMultimap<K,
V>
-
get
Returns a view collection of the values associated withkey
in this multimap, if any. Note that whencontainsKey(key)
is false, this returns an empty collection, notnull
.Changes to the returned collection will update the underlying multimap, and vice versa.
The returned collection is not serializable.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface. -
entries
Returns a view collection of all key-value pairs contained in this multimap, asMap.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.
The iterator generated by the returned collection traverses the values for one key, followed by the values of a second key, and so on.
Each entry is an immutable snapshot of a key-value mapping in the multimap, taken at the time the entry is returned by a method call to the collection or its iterator.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface. -
removeAll
Removes all values associated with the keykey
.Once this method returns,
key
will not be mapped to any values, so it will not appear inMultimap.keySet()
,Multimap.asMap()
, or any other views.The returned collection is immutable.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface.- Specified by:
removeAll
in interfaceMultimap<K,
V> - Specified by:
removeAll
in interfaceSetMultimap<K,
V> - Overrides:
removeAll
in classAbstractMapBasedMultimap<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.
-
replaceValues
Stores a collection of values with the same key, replacing any existing values for that key.If
values
is empty, this is equivalent toremoveAll(key)
.The returned collection is immutable.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface.Any duplicates in
values
will be stored in the multimap once.- Specified by:
replaceValues
in interfaceMultimap<K,
V> - Specified by:
replaceValues
in interfaceSetMultimap<K,
V> - Overrides:
replaceValues
in classAbstractMapBasedMultimap<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.
-
asMap
Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values. Note thatthis.asMap().get(k)
is equivalent tothis.get(k)
only whenk
is a key contained in the multimap; otherwise it returnsnull
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
orputAll
, nor do its entries supportsetValue
.Though the method signature doesn't say so explicitly, the returned map has
Set
values. -
put
Stores a key-value pair in the multimap.- Specified by:
put
in interfaceMultimap<K,
V> - Overrides:
put
in classAbstractMapBasedMultimap<K,
V> - Parameters:
key
- key to store in the multimapvalue
- value to store in the multimap- Returns:
true
if the method increased the size of the multimap, orfalse
if the multimap already contained the key-value pair
-
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.
-