Class Synchronized.SynchronizedMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,
,V> Serializable
- Direct Known Subclasses:
Synchronized.SynchronizedListMultimap
,Synchronized.SynchronizedSetMultimap
- Enclosing class:
Synchronized
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) Map
<K, Collection<V>> (package private) Collection
<Map.Entry<K, V>> private static final long
(package private) Collection
<V> Fields inherited from class com.google.common.collect.Synchronized.SynchronizedObject
delegate, mutex
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionMap
<K, Collection<V>> asMap()
Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values.void
clear()
Removes all key-value pairs from the multimap, leaving it empty.boolean
containsEntry
(Object key, Object value) Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.boolean
containsKey
(Object key) Returnstrue
if this multimap contains at least one key-value pair with the keykey
.boolean
containsValue
(Object value) Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.delegate()
entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.boolean
Compares the specified object with this multimap for equality.void
forEach
(BiConsumer<? super K, ? super V> action) Performs the given action for all key-value pairs contained in this multimap.Returns a view collection of the values associated withkey
in this multimap, if any.int
hashCode()
Returns the hash code for this multimap.boolean
isEmpty()
Returnstrue
if this multimap contains no key-value pairs.keys()
Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates.keySet()
Returns a view collection of all distinct keys contained in this multimap.boolean
Stores a key-value pair in this multimap.boolean
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.boolean
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
.boolean
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists.Removes all values associated with the keykey
.replaceValues
(K key, 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.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 com.google.common.collect.Synchronized.SynchronizedObject
toString
-
Field Details
-
keySet
-
valuesCollection
-
entries
-
asMap
-
keys
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
SynchronizedMultimap
-
-
Method Details
-
delegate
- Overrides:
delegate
in classSynchronized.SynchronizedObject
-
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. -
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. -
containsKey
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,
V>
-
containsValue
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,
V>
-
containsEntry
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,
V>
-
get
Description copied from interface:Multimap
Returns a view collection of the values associated withkey
in this multimap, if any. Note that whencontainsKey(key)
is false, this returns an empty collection, notnull
.Changes to the returned collection will update the underlying multimap, and vice versa.
-
put
Description copied from interface:Multimap
Stores a key-value pair in this multimap.Some multimap implementations allow duplicate key-value pairs, in which case
put
always adds a new key-value pair and increases the multimap size by 1. Other implementations prohibit duplicates, and storing a key-value pair that's already in the multimap has no effect. -
putAll
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
Description copied from interface:Multimap
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
. -
replaceValues
Description copied from interface:Multimap
Stores a collection of values with the same key, replacing any existing values for that key.If
values
is empty, this is equivalent toremoveAll(key)
.- Specified by:
replaceValues
in interfaceMultimap<K,
V> - 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.
-
remove
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. -
removeAll
Description copied from interface:Multimap
Removes all values associated with the keykey
.Once this method returns,
key
will not be mapped to any values, so it will not appear inMultimap.keySet()
,Multimap.asMap()
, or any other views. -
clear
public void clear()Description copied from interface:Multimap
Removes all key-value pairs from the multimap, leaving it empty. -
keySet
Description copied from interface:Multimap
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.
-
values
Description copied from interface:Multimap
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.
-
entries
Description copied from interface:Multimap
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.
-
forEach
Description copied from interface:Multimap
Performs the given action for all key-value pairs contained in this multimap. If an ordering is specified by theMultimap
implementation, actions will be performed in the order of iteration ofMultimap.entries()
. Exceptions thrown by the action are relayed to the caller.To loop over all keys and their associated value collections, write
Multimaps.asMap(multimap).forEach((key, valueCollection) -> action())
. -
asMap
Description copied from interface:Multimap
Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values. Note thatthis.asMap().get(k)
is equivalent tothis.get(k)
only whenk
is a key contained in the multimap; otherwise it returnsnull
as opposed to an empty collection.Changes to the returned map or the collections that serve as its values will update the underlying multimap, and vice versa. The map does not support
put
orputAll
, nor do its entries supportsetValue
. -
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.
-
equals
Description copied from interface:Multimap
Compares the specified object with this multimap for equality. Two multimaps are equal when their map views, as returned byMultimap.asMap()
, are also equal.In general, two multimaps with identical key-value mappings may or may not be equal, depending on the implementation. For example, two
SetMultimap
instances with the same key-value mappings are equal, but equality of twoListMultimap
instances depends on the ordering of the values for each key.A non-empty
SetMultimap
cannot be equal to a non-emptyListMultimap
, since theirMultimap.asMap()
views contain unequal collections as values. However, any two empty multimaps are equal, because they both have emptyMultimap.asMap()
views. -
hashCode
public int hashCode()Description copied from interface:Multimap
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()
.In general, two multimaps with identical key-value mappings may or may not have the same hash codes, depending on the implementation. For example, two
SetMultimap
instances with the same key-value mappings will have the samehashCode
, but thehashCode
ofListMultimap
instances depends on the ordering of the values for each key.
-