Class TreeMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- java.lang.Object
-
- com.google.common.collect.TreeMultimap<K,V>
-
- All Implemented Interfaces:
Multimap<K,V>
,SetMultimap<K,V>
,SortedSetMultimap<K,V>
,java.io.Serializable
@GwtCompatible(serializable=true, emulated=true) public class TreeMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object> extends java.lang.Object
Implementation ofMultimap
whose keys and values are ordered by their natural ordering or by supplied comparators. In all cases, this implementation usesComparable.compareTo(T)
orComparator.compare(T, T)
instead ofObject.equals(java.lang.Object)
to determine equivalence of instances.Warning: The comparators or comparables used must be consistent with equals as explained by the
Comparable
class specification. Otherwise, the resulting multiset will violate the general contract ofSetMultimap
, which is specified in terms ofObject.equals(java.lang.Object)
.The collections returned by
keySet
andasMap
iterate through the keys according to the key comparator ordering or the natural ordering of the keys. Similarly,get
,removeAll
, andreplaceValues
return collections that iterate through the values according to the value comparator ordering or the natural ordering of the values. The collections generated byentries
,keys
, andvalues
iterate across the keys according to the above key ordering, and for each key they iterate across the values according to the value ordering.The multimap does not store duplicate key-value pairs. Adding a new key-value pair equal to an existing key-value pair has no effect.
Null keys and values are permitted (provided, of course, that the respective comparators support them). All optional multimap methods are supported, and all returned views are modifiable.
This class is not threadsafe when any concurrent operations update the multimap. Concurrent read operations will work correctly. To allow concurrent update operations, wrap your multimap with a call to
Multimaps.synchronizedSortedSetMultimap(com.google.common.collect.SortedSetMultimap<K, V>)
.See the Guava User Guide article on
Multimap
.- Since:
- 2.0
- Author:
- Jared Levy, Louis Wasserman
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.NavigableMap<K,java.util.Collection<V>>
asMap()
Returns a map view that associates each key with the corresponding values in the multimap.void
clear()
Removes all key-value pairs from the multimap, leaving it empty.boolean
containsEntry(java.lang.Object key, java.lang.Object value)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.boolean
containsKey(java.lang.Object key)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.boolean
containsValue(java.lang.Object value)
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.static <K extends java.lang.Comparable,V extends java.lang.Comparable>
TreeMultimap<K,V>create()
Creates an emptyTreeMultimap
ordered by the natural ordering of its keys and values.static <K extends java.lang.Comparable,V extends java.lang.Comparable>
TreeMultimap<K,V>create(Multimap<? extends K,? extends V> multimap)
Constructs aTreeMultimap
, ordered by the natural ordering of its keys and values, with the same mappings as the specified multimap.static <K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
TreeMultimap<K,V>create(java.util.Comparator<? super K> keyComparator, java.util.Comparator<? super V> valueComparator)
Creates an emptyTreeMultimap
instance using explicit comparators.java.util.Set<java.util.Map.Entry<K,V>>
entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.boolean
equals(java.lang.Object object)
Compares the specified object to this multimap for equality.java.util.NavigableSet<V>
get(K key)
Returns a collection view of all values associated with a key.int
hashCode()
Returns the hash code for this multimap.boolean
isEmpty()
Returnstrue
if this multimap contains no key-value pairs.java.util.Comparator<? super K>
keyComparator()
Deprecated.Use((NavigableSet<K>) multimap.keySet()).comparator()
instead.Multiset<K>
keys()
Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates.java.util.NavigableSet<K>
keySet()
Returns a view collection of all distinct keys contained in this multimap.boolean
put(K key, V value)
Stores a key-value pair in the multimap.boolean
putAll(Multimap<? extends K,? extends V> multimap)
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.boolean
putAll(K key, java.lang.Iterable<? extends V> values)
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
.boolean
remove(java.lang.Object key, java.lang.Object value)
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists.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.int
size()
Returns the number of key-value pairs in this multimap.java.lang.String
toString()
Returns a string representation of the multimap, generated by callingtoString
on the map returned byMultimap.asMap()
.java.util.Comparator<? super V>
valueComparator()
Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.java.util.Collection<V>
values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, put, putAll, putAll, remove, size
-
Methods inherited from interface com.google.common.collect.SetMultimap
entries, equals
-
-
-
-
Method Detail
-
create
public static <K extends java.lang.Comparable,V extends java.lang.Comparable> TreeMultimap<K,V> create()
Creates an emptyTreeMultimap
ordered by the natural ordering of its keys and values.
-
create
public static <K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object> TreeMultimap<K,V> create(java.util.Comparator<? super K> keyComparator, java.util.Comparator<? super V> valueComparator)
Creates an emptyTreeMultimap
instance using explicit comparators. Neither comparator may be null; useOrdering.natural()
to specify natural order.- Parameters:
keyComparator
- the comparator that determines the key orderingvalueComparator
- the comparator that determines the value ordering
-
create
public static <K extends java.lang.Comparable,V extends java.lang.Comparable> TreeMultimap<K,V> create(Multimap<? extends K,? extends V> multimap)
Constructs aTreeMultimap
, ordered by the natural ordering of its keys and values, with the same mappings as the specified multimap.- Parameters:
multimap
- the multimap whose contents are copied to this multimap
-
keyComparator
@Deprecated public java.util.Comparator<? super K> keyComparator()
Deprecated.Use((NavigableSet<K>) multimap.keySet()).comparator()
instead.Returns the comparator that orders the multimap keys.
-
valueComparator
public java.util.Comparator<? super V> valueComparator()
Description copied from interface:SortedSetMultimap
Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.
-
get
@GwtIncompatible public java.util.NavigableSet<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.- Specified by:
get
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
get
in interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
get
in interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Since:
- 14.0 (present with return type
SortedSet
since 2.0)
-
keySet
public java.util.NavigableSet<K> keySet()
Returns a view collection of all distinct keys contained in this multimap. Note that the key set contains a key if and only if this multimap maps that key to at least one value.Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible.
Because a
TreeMultimap
has unique sorted keys, this method returns aNavigableSet
, instead of theSet
specified in theMultimap
interface.
-
asMap
public java.util.NavigableMap<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 asSortedSetMultimap.get(K)
, returning a live collection. When passed a key that is not present, however,asMap().get(Object)
returnsnull
instead of an empty collection.Though the method signature doesn't say so explicitly, the returned map has
SortedSet
values.Because a
TreeMultimap
has unique sorted keys, this method returns aNavigableMap
, instead of theMap
specified in theMultimap
interface.- Specified by:
asMap
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
asMap
in interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Specified by:
asMap
in interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Since:
- 14.0 (present with return type
SortedMap
since 2.0)
-
removeAll
@CanIgnoreReturnValue public java.util.SortedSet<V> removeAll(@CheckForNull java.lang.Object key)
Removes all values associated with a given key. The returned collection is immutable.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>
- Specified by:
removeAll
in interfaceSortedSetMultimap<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 public 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. The returned collection is immutable.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>
- Specified by:
replaceValues
in interfaceSortedSetMultimap<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.
-
values
public java.util.Collection<V> values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
The iterator generated by the returned collection traverses the values for one key, followed by the values of a second key, and so on.
Consequently, the values do not follow their natural ordering or the ordering of the value comparator.
-
entries
public java.util.Set<java.util.Map.Entry<K,V>> entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
The iterator generated by the returned collection traverses the values for one key, followed by the values of a second key, and so on.
Each entry is an immutable snapshot of a key-value mapping in the multimap, taken at the time the entry is returned by a method call to the collection or its iterator.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface.
-
put
@CanIgnoreReturnValue public boolean put(K key, V value)
Stores a key-value pair in the multimap.- Specified by:
put
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Parameters:
key
- key to store in the multimapvalue
- value to store in the multimap- Returns:
true
if the method increased the size of the multimap, orfalse
if the multimap already contained the key-value pair
-
equals
public boolean equals(@CheckForNull java.lang.Object object)
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.
-
size
public int size()
Description copied from interface:Multimap
Returns the number of key-value pairs in this multimap.Note: this method does not return the number of distinct keys in the multimap, which is given by
keySet().size()
orasMap().size()
. See the opening section of theMultimap
class documentation for clarification.
-
containsKey
public boolean containsKey(@CheckForNull java.lang.Object key)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.- Specified by:
containsKey
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
clear
public void clear()
Description copied from interface:Multimap
Removes all key-value pairs from the multimap, leaving it empty.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Multimap
Returnstrue
if this multimap contains no key-value pairs. Equivalent tosize() == 0
, but can in some cases be more efficient.
-
containsValue
public boolean containsValue(@CheckForNull java.lang.Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.- Specified by:
containsValue
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
containsEntry
public boolean containsEntry(@CheckForNull java.lang.Object key, @CheckForNull java.lang.Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.- Specified by:
containsEntry
in interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
remove
@CanIgnoreReturnValue public boolean remove(@CheckForNull java.lang.Object key, @CheckForNull java.lang.Object value)
Description copied from interface:Multimap
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified.
-
putAll
@CanIgnoreReturnValue public boolean putAll(K key, java.lang.Iterable<? extends V> values)
Description copied from interface:Multimap
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
. Equivalent to (but expected to be more efficient than):for (V value : values) { put(key, value); }
In particular, this is a no-op if
values
is empty.
-
putAll
@CanIgnoreReturnValue public boolean putAll(Multimap<? extends K,? extends V> multimap)
Description copied from interface:Multimap
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.
-
keys
public Multiset<K> keys()
Description copied from interface:Multimap
Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates. This collection has the same size as this multimap, andkeys().count(k) == get(k).size()
for allk
.Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
-
hashCode
public int hashCode()
Returns the hash code for this multimap.The hash code of a multimap is defined as the hash code of the map view, as returned by
Multimap.asMap()
.
-
toString
public java.lang.String toString()
Returns a string representation of the multimap, generated by callingtoString
on the map returned byMultimap.asMap()
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of the multimap
-
-