Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (C) 2007 The Guava Authors
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package com.google.common.collect;
 
 
 import java.util.Map;
 import java.util.Set;
 
A SetMultimap whose set of values for a given key are kept sorted; that is, they comprise a java.util.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. See the com.google.common.collect.Multimap documentation for information common to all multimaps.

The get(java.lang.Object), removeAll(java.lang.Object), and replaceValues(java.lang.Object,java.lang.Iterable) methods each return a java.util.SortedSet of values, while com.google.common.collect.Multimap.entries() returns a java.util.Set of map entries. Though the method signature doesn't say so explicitly, the map returned by asMap() has SortedSet values.

See the Guava User Guide article on Multimap.

Author(s):
Jared Levy
Since:
2.0 (imported from Google Collections Library)
 
 public interface SortedSetMultimap<K, V> extends SetMultimap<K, V> {
   // Following Javadoc copied from Multimap.
 
  
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 java.util.SortedSet, instead of the java.util.Collection specified in the com.google.common.collect.Multimap interface.

 
   @Override
   SortedSet<V> get(@Nullable K key);

  
Removes all values associated with a given key.

Because a SortedSetMultimap has unique sorted values for a given key, this method returns a java.util.SortedSet, instead of the java.util.Collection specified in the com.google.common.collect.Multimap interface.

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

  
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 java.util.SortedSet, instead of the java.util.Collection specified in the com.google.common.collect.Multimap interface.

Any duplicates in values will be stored in the multimap once.

 
   @Override
   SortedSet<V> replaceValues(K keyIterable<? extends V> values);

  
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(java.lang.Object), returning a live collection. When passed a key that is not present, however, asMap().get(Object) returns null instead of an empty collection.

Note: The returned map's values are guaranteed to be of type java.util.SortedSet. To obtain this map with the more specific generic type Map<K, SortedSet<V>>, call com.google.common.collect.Multimaps.asMap(com.google.common.collect.SortedSetMultimap) instead.

  @Override Map<K, Collection<V>> asMap();

  
Returns the comparator that orders the multimap values, with null indicating that natural ordering is used.
  Comparator<? super V> valueComparator();
New to GrepCode? Check out our FAQ X