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 Multimap that cannot hold duplicate key-value pairs. Adding a key-value pair that's already in the multimap has no effect. See the 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.Set of values, while entries() returns a Set of map entries. Though the method signature doesn't say so explicitly, the map returned by asMap() has Set values.

If the values corresponding to a single key should be ordered according to a java.util.Comparator (or the natural order), see the SortedSetMultimap subinterface.

Since the value collections are sets, the behavior of a SetMultimap is not specified if key or value objects already present in the multimap change in a manner that affects equals comparisons. Use caution if mutable objects are used as keys or values in a SetMultimap.

See the Guava User Guide article on Multimap.

Author(s):
Jared Levy
Since:
2.0 (imported from Google Collections Library)
 
 public interface SetMultimap<K, V> extends Multimap<K, V> {
  

Because a SetMultimap has unique values for a given key, this method returns a java.util.Set, instead of the java.util.Collection specified in the Multimap interface.

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

  

Because a SetMultimap has unique values for a given key, this method returns a java.util.Set, instead of the java.util.Collection specified in the Multimap interface.

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

  

Because a SetMultimap has unique values for a given key, this method returns a java.util.Set, instead of the java.util.Collection specified in the Multimap interface.

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

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

  

Because a SetMultimap has unique values for a given key, this method returns a java.util.Set, instead of the java.util.Collection specified in the Multimap interface.

 
   @Override
   Set<Map.Entry<K, V>> entries();

  

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

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

  
Compares the specified object to this multimap for equality.

Two SetMultimap instances are equal if, for each key, they contain the same values. Equality does not depend on the ordering of keys or values.

An empty SetMultimap is equal to any other empty Multimap, including an empty ListMultimap.

  boolean equals(@Nullable Object obj);
New to GrepCode? Check out our FAQ X