Class AbstractMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,V>
- Direct Known Subclasses:
AbstractMapBasedMultimap,BaseImmutableMultimap,FilteredEntryMultimap,FilteredKeyMultimap,LinkedListMultimap,Multimaps.MapMultimap,Multimaps.TransformedEntriesMultimap
Multimap implementation, not necessarily in terms of a Map.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class(package private) class(package private) class -
Field Summary
Fields -
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.booleancontainsEntry(Object key, Object value) Returnstrueif this multimap contains at least one key-value pair with the keykeyand the valuevalue.booleancontainsValue(Object value) Returnstrueif this multimap contains at least one key-value pair with the valuevalue.(package private) abstract Map<K, Collection<V>> (package private) abstract Collection<Map.Entry<K, V>> (package private) abstract Collection<V> entries()Returns a view collection of all key-value pairs contained in this multimap, asMap.Entryinstances.(package private) Spliterator<Map.Entry<K, V>> booleanCompares the specified object with this multimap for equality.inthashCode()Returns the hash code for this multimap.booleanisEmpty()Returnstrueif 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.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.replaceValues(K key, Iterable<? extends V> values) Stores a collection of values with the same key, replacing any existing values for that key.toString()Returns a string representation of the multimap, generated by callingtoStringon the map returned byMultimap.asMap().values()Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()).(package private) Spliterator<V>
-
Field Details
-
entries
-
keySet
-
keys
-
values
-
asMap
-
-
Constructor Details
-
AbstractMultimap
AbstractMultimap()
-
-
Method Details
-
isEmpty
public boolean isEmpty()Description copied from interface:MultimapReturnstrueif this multimap contains no key-value pairs. Equivalent tosize() == 0, but can in some cases be more efficient. -
containsValue
Description copied from interface:MultimapReturnstrueif this multimap contains at least one key-value pair with the valuevalue.- Specified by:
containsValuein interfaceMultimap<K,V>
-
containsEntry
Description copied from interface:MultimapReturnstrueif this multimap contains at least one key-value pair with the keykeyand the valuevalue.- Specified by:
containsEntryin interfaceMultimap<K,V>
-
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. -
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(). -
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> - 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.
-
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.
-
createEntries
-
entryIterator
-
entrySpliterator
Spliterator<Map.Entry<K,V>> entrySpliterator() -
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.
-
createKeySet
-
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.
-
createKeys
-
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.
-
createValues
-
valueIterator
-
valueSpliterator
Spliterator<V> valueSpliterator() -
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. -
createAsMap
-
equals
Description copied from interface:MultimapCompares 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
SetMultimapinstances with the same key-value mappings are equal, but equality of twoListMultimapinstances depends on the ordering of the values for each key.A non-empty
SetMultimapcannot 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()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
Returns a string representation of the multimap, generated by callingtoStringon the map returned byMultimap.asMap().
-