Class Multimaps.UnmodifiableMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,,V> Serializable
- Direct Known Subclasses:
Multimaps.UnmodifiableListMultimap,Multimaps.UnmodifiableSetMultimap
- Enclosing class:
- Multimaps
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) Collection<Map.Entry<K,V>> (package private) Map<K,Collection<V>> private static final long(package private) Collection<V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionMap<K,Collection<V>> asMap()Returns a view of this multimap as aMapfrom each distinct key to the nonempty collection of that key's associated values.voidclear()Removes all key-value pairs from the multimap, leaving it empty.delegate()Returns the backing delegate instance that methods are forwarded to.entries()Returns a view collection of all key-value pairs contained in this multimap, asMap.Entryinstances.voidforEach(BiConsumer<? super K, ? super V> consumer) Performs the given action for all key-value pairs contained in this multimap.Returns a view collection of the values associated withkeyin this multimap, if any.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.booleanStores a key-value pair in this multimap.booleanStores all key-value pairs ofmultimapin this multimap, in the order returned bymultimap.entries().booleanStores a key-value pair in this multimap for each ofvalues, all using the same key,key.booleanRemoves a single key-value pair with the keykeyand the valuevaluefrom 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.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.ForwardingMultimap
containsEntry, containsKey, containsValue, equals, hashCode, isEmpty, sizeMethods inherited from class com.google.common.collect.ForwardingObject
toString
-
Field Details
-
delegate
-
entries
-
keys
-
keySet
-
values
-
map
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
UnmodifiableMultimap
-
-
Method Details
-
delegate
Description copied from class:ForwardingObjectReturns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegatein classForwardingMultimap<K,V>
-
clear
public void clear()Description copied from interface:MultimapRemoves all key-value pairs from the multimap, leaving it empty. -
asMap
Description copied from interface:MultimapReturns a view of this multimap as aMapfrom each distinct key to the nonempty collection of that key's associated values. Note thatthis.asMap().get(k)is equivalent tothis.get(k)only whenkis a key contained in the multimap; otherwise it returnsnullas 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
putorputAll, nor do its entries supportsetValue. -
entries
Description copied from interface:MultimapReturns a view collection of all key-value pairs contained in this multimap, asMap.Entryinstances.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:MultimapPerforms the given action for all key-value pairs contained in this multimap. If an ordering is specified by theMultimapimplementation, 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()). -
get
Description copied from interface:MultimapReturns a view collection of the values associated withkeyin 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.
-
keys
Description copied from interface:MultimapReturns 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.
-
keySet
Description copied from interface:MultimapReturns 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.
-
put
Description copied from interface:MultimapStores a key-value pair in this multimap.Some multimap implementations allow duplicate key-value pairs, in which case
putalways 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:MultimapStores 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
valuesis empty. -
putAll
Description copied from interface:MultimapStores all key-value pairs ofmultimapin this multimap, in the order returned bymultimap.entries(). -
remove
Description copied from interface:MultimapRemoves a single key-value pair with the keykeyand the valuevaluefrom 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:MultimapRemoves all values associated with the keykey.Once this method returns,
keywill not be mapped to any values, so it will not appear inMultimap.keySet(),Multimap.asMap(), or any other views. -
replaceValues
Description copied from interface:MultimapStores a collection of values with the same key, replacing any existing values for that key.If
valuesis empty, this is equivalent toremoveAll(key).- Specified by:
replaceValuesin interfaceMultimap<K,V> - Overrides:
replaceValuesin classForwardingMultimap<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.
-
values
Description copied from interface:MultimapReturns 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.
-