@GwtCompatible public interface SortedSetMultimap<K,V> extends SetMultimap<K,V>
SetMultimap
whose set of values for a given key are kept sorted;
that is, they comprise a SortedSet
. 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.
The get(K)
, removeAll(java.lang.Object)
, and replaceValues(K, java.lang.Iterable<? extends V>)
methods
each return a SortedSet
of values, while Multimap.entries()
returns a Set
of map entries. Though the method signature doesn't say
so explicitly, the map returned by asMap()
has SortedSet
values.
Modifier and Type | Method and Description |
---|---|
Map<K,Collection<V>> |
asMap()
Returns a map view that associates each key with the corresponding values
in the multimap.
|
SortedSet<V> |
get(K key)
Returns a collection view of all values associated with a key.
|
SortedSet<V> |
removeAll(Object key)
Removes all values associated with a given key.
|
SortedSet<V> |
replaceValues(K key,
Iterable<? extends V> values)
Stores a collection of values with the same key, replacing any existing
values for that key.
|
Comparator<? super V> |
valueComparator()
Returns the comparator that orders the multimap values, with a
null
indicating that natural ordering is used. |
entries, equals
clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
SortedSet<V> get(@Nullable K key)
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 a SortedSet
, instead of the
Collection
specified in the Multimap
interface.
SortedSet<V> removeAll(@Nullable Object key)
Because a SortedSetMultimap
has unique sorted values for a given
key, this method returns a SortedSet
, instead of the
Collection
specified in the Multimap
interface.
removeAll
in interface Multimap<K,V>
removeAll
in interface SetMultimap<K,V>
key
- key of entries to remove from the multimapSortedSet<V> replaceValues(K key, Iterable<? extends V> values)
Because a SortedSetMultimap
has unique sorted values for a given
key, this method returns a SortedSet
, instead of the
Collection
specified in the Multimap
interface.
Any duplicates in values
will be stored in the multimap once.
replaceValues
in interface Multimap<K,V>
replaceValues
in interface SetMultimap<K,V>
key
- key to store in the multimapvalues
- values to store in the multimapMap<K,Collection<V>> asMap()
setValue()
on its entries, put
, or putAll
.
When passed a key that is present in the map, asMap().get(Object)
has the same behavior as get(K)
, returning a
live collection. When passed a key that is not present, however, asMap().get(Object)
returns null
instead of an empty collection.
Though the method signature doesn't say so explicitly, the returned map
has SortedSet
values.
Comparator<? super V> valueComparator()
null
indicating that natural ordering is used.Copyright © 2010-2012. All Rights Reserved.