javadoc.com.google.common.collect.SortedSetMultimap.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guava-osgi

Repackaging of Google Guava libraries as OSGi bundle

The newest version!








SortedSetMultimap (Guava: Google Core Libraries for Java 11.0.1 API)























  
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD









com.google.common.collect


Interface SortedSetMultimap<K,V>

All Superinterfaces: 
Multimap<K,V>, SetMultimap<K,V>


All Known Implementing Classes: 
ForwardingSortedSetMultimap, TreeMultimap



@GwtCompatible
public interface SortedSetMultimap<K,V>extends SetMultimap<K,V>




A 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) 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.




Since:
  2.0 (imported from Google Collections Library)
Author:
  Jared Levy











Method Summary



 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 null
 indicating that natural ordering is used.


 


Methods inherited from interface com.google.common.collect.SetMultimap


entries, equals


 


Methods inherited from interface com.google.common.collect.Multimap


clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values


 








Method Detail




get
SortedSet<V> get(@Nullable
                 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 a SortedSet, instead of the
 Collection specified in the Multimap interface.


Specified by:
get in interface Multimap<K,V>
Specified by:
get in interface SetMultimap<K,V>


Parameters:
key - key to search for in multimap
Returns:
the collection of values that the key maps to





removeAll
SortedSet<V> removeAll(@Nullable
                       Object key)

Removes all values associated with a given 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.


Specified by:
removeAll in interface Multimap<K,V>
Specified by:
removeAll in interface SetMultimap<K,V>


Parameters:
key - key of entries to remove from the multimap
Returns:
the collection of removed values, or an empty collection if no
     values were associated with the provided key. The collection
     may be modifiable, but updating it will have no effect on the
     multimap.





replaceValues
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.

 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.


Specified by:
replaceValues in interface Multimap<K,V>
Specified by:
replaceValues in interface SetMultimap<K,V>


Parameters:
key - key to store in the multimap
values - values to store in the multimap
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
Map<K,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 support 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.


Specified by:
asMap in interface Multimap<K,V>
Specified by:
asMap in interface SetMultimap<K,V>



Returns:
a map view from a key to its collection of values





valueComparator
Comparator<? super V> valueComparator()

Returns the comparator that orders the multimap values, with null
 indicating that natural ordering is used.




















  
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Copyright © 2010-2012. All Rights Reserved.

Method Summary
`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 `null` indicating that natural ordering is used.

javadoc.com.google.common.collect.SortedSetMultimap.html Maven / Gradle / Ivy

com.google.common.collect Interface SortedSetMultimap<K,V>

get

removeAll

replaceValues

asMap

valueComparator

com.google.common.collect
Interface SortedSetMultimap<K,V>