Interface SortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
- All Superinterfaces:
Multimap<K,V>
,SetMultimap<K,V>
- All Known Implementing Classes:
ForwardingSortedSetMultimap
,TreeMultimap
@GwtCompatible public interface SortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object> extends SetMultimap<K,V>
ASetMultimap
whose set of values for a given key are kept sorted; that is, they comprise aSortedSet
. It cannot hold duplicate key-value pairs; adding a key-value pair that's already in the multimap has no effect. This interface does not specify the ordering of the multimap's keys. See theMultimap
documentation for information common to all multimaps.The
get(K)
,removeAll(java.lang.Object)
, andreplaceValues(K, java.lang.Iterable<? extends V>)
methods each return aSortedSet
of values, whileMultimap.entries()
returns aSet
of map entries. Though the method signature doesn't say so explicitly, the map returned byasMap()
hasSortedSet
values.Warning: As in all
SetMultimap
s, do not modify either a key or a value of aSortedSetMultimap
in a way that affects itsObject.equals(java.lang.Object)
behavior (or its position in the order of the values). Undefined behavior and bugs will result.See the Guava User Guide article on
Multimap
.- Since:
- 2.0
- Author:
- Jared Levy
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<K,java.util.Collection<V>>
asMap()
Returns a map view that associates each key with the corresponding values in the multimap.java.util.SortedSet<V>
get(K key)
Returns a collection view of all values associated with a key.java.util.SortedSet<V>
removeAll(java.lang.Object key)
Removes all values associated with a given key.java.util.SortedSet<V>
replaceValues(K key, java.lang.Iterable<? extends V> values)
Stores a collection of values with the same key, replacing any existing values for that key.java.util.Comparator<? super V>
valueComparator()
Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.-
Methods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
-
Methods inherited from interface com.google.common.collect.SetMultimap
entries, equals
-
-
-
-
Method Detail
-
get
java.util.SortedSet<V> get(K key)
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
@CanIgnoreReturnValue java.util.SortedSet<V> removeAll(@CheckForNull java.lang.Object key)
Removes all values associated with a given key.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 extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
removeAll
in interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- 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
@CanIgnoreReturnValue java.util.SortedSet<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
Stores a collection of values with the same key, replacing any existing values for that key.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 extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
replaceValues
in interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- 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
java.util.Map<K,java.util.Collection<V>> 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.Note: The returned map's values are guaranteed to be of type
SortedSet
. To obtain this map with the more specific generic typeMap<K, SortedSet<V>>
, callMultimaps.asMap(SortedSetMultimap)
instead. However, the returned map itself is not necessarily aSortedMap
: ASortedSetMultimap
must expose the values for a given key in sorted order, but it need not expose the keys in sorted order. IndividualSortedSetMultimap
implementations, like those built withMultimapBuilder.treeKeys()
, may make additional guarantees.
-
valueComparator
@CheckForNull java.util.Comparator<? super V> valueComparator()
Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.
-
-