Class AbstractSortedSetMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,
,V> SetMultimap<K,
,V> SortedSetMultimap<K,
,V> Serializable
- Direct Known Subclasses:
AbstractSortedKeySortedSetMultimap
,Multimaps.CustomSortedSetMultimap
SortedSetMultimap
interface. It's a wrapper around AbstractMapBasedMultimap
that converts the returned collections into sorted sets. The createCollection()
method must return a SortedSet
.-
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
AbstractSortedSetMultimap
(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 map view that associates each key with the corresponding values in the multimap.Creates the collection of values for a single key.Creates an unmodifiable, empty collection of values.Returns a collection view of all values associated with a key.Removes all values associated with a given key.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> SortedSet
<E> unmodifiableCollectionSubclass
(Collection<E> collection) values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).(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.AbstractSetMultimap
entries, equals, put
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, 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, put, putAll, putAll, remove, size
Methods inherited from interface com.google.common.collect.SetMultimap
entries, equals
Methods inherited from interface com.google.common.collect.SortedSetMultimap
valueComparator
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
AbstractSortedSetMultimap
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 classAbstractSetMultimap<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 classAbstractSetMultimap<K,
V>
-
unmodifiableCollectionSubclass
- Overrides:
unmodifiableCollectionSubclass
in classAbstractSetMultimap<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 classAbstractSetMultimap<K,
V>
-
get
Returns a collection view of all values associated with a key. If no mappings in the multimap have the provided key, an empty collection is returned.Changes to the returned collection will update the underlying multimap, and vice versa.
Because a
SortedSetMultimap
has unique sorted values for a given key, this method returns aSortedSet
, instead of theCollection
specified in theMultimap
interface. -
removeAll
Removes all values associated with a given key. The returned collection is immutable.Because a
SortedSetMultimap
has unique sorted values for a given key, this method returns aSortedSet
, instead of theCollection
specified in theMultimap
interface.- Specified by:
removeAll
in interfaceMultimap<K,
V> - Specified by:
removeAll
in interfaceSetMultimap<K,
V> - Specified by:
removeAll
in interfaceSortedSetMultimap<K,
V> - Overrides:
removeAll
in classAbstractSetMultimap<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. The returned collection is immutable.Because a
SortedSetMultimap
has unique sorted values for a given key, this method returns aSortedSet
, 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> - Specified by:
replaceValues
in interfaceSortedSetMultimap<K,
V> - Overrides:
replaceValues
in classAbstractSetMultimap<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 map view that associates each key with the corresponding values in the multimap. Changes to the returned map, such as element removal, will update the underlying multimap. The map does not supportsetValue
on its entries,put
, orputAll
.When passed a key that is present in the map,
asMap().get(Object)
has the same behavior asget(K)
, returning a live collection. When passed a key that is not present, however,asMap().get(Object)
returnsnull
instead of an empty collection.Though the method signature doesn't say so explicitly, the returned map has
SortedSet
values. -
values
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).Changes to the returned collection 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.
Consequently, the values do not follow their natural ordering or the ordering of the value comparator.
-