abstract class AbstractMultimap<K,V> extends java.lang.Object implements Multimap<K,V>
Multimap
implementation, not necessarily in terms of a Map
.Modifier and Type | Class and Description |
---|---|
(package private) class |
AbstractMultimap.Entries |
(package private) class |
AbstractMultimap.EntrySet |
(package private) class |
AbstractMultimap.Values |
Modifier and Type | Field and Description |
---|---|
private java.util.Map<K,java.util.Collection<V>> |
asMap |
private java.util.Collection<java.util.Map.Entry<K,V>> |
entries |
private Multiset<K> |
keys |
private java.util.Set<K> |
keySet |
private java.util.Collection<V> |
values |
Constructor and Description |
---|
AbstractMultimap() |
Modifier and Type | Method and Description |
---|---|
java.util.Map<K,java.util.Collection<V>> |
asMap()
Returns a view of this multimap as a
Map from each distinct key to the nonempty
collection of that key's associated values. |
boolean |
containsEntry(java.lang.Object key,
java.lang.Object value)
Returns
true if this multimap contains at least one key-value pair with the key key and the value value . |
boolean |
containsValue(java.lang.Object value)
Returns
true if this multimap contains at least one key-value pair with the value
value . |
(package private) abstract java.util.Map<K,java.util.Collection<V>> |
createAsMap() |
(package private) abstract java.util.Collection<java.util.Map.Entry<K,V>> |
createEntries() |
(package private) abstract Multiset<K> |
createKeys() |
(package private) abstract java.util.Set<K> |
createKeySet() |
(package private) abstract java.util.Collection<V> |
createValues() |
java.util.Collection<java.util.Map.Entry<K,V>> |
entries()
Returns a view collection of all key-value pairs contained in this multimap, as
Map.Entry
instances. |
(package private) abstract java.util.Iterator<java.util.Map.Entry<K,V>> |
entryIterator() |
(package private) java.util.Spliterator<java.util.Map.Entry<K,V>> |
entrySpliterator() |
boolean |
equals(java.lang.Object object)
Compares the specified object with this multimap for equality.
|
int |
hashCode()
Returns the hash code for this multimap.
|
boolean |
isEmpty()
Returns
true if this multimap contains no key-value pairs. |
Multiset<K> |
keys()
Returns a view collection containing the key from each key-value pair in this multimap,
without collapsing duplicates.
|
java.util.Set<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 this multimap.
|
boolean |
putAll(K key,
java.lang.Iterable<? extends V> values)
Stores a key-value pair in this multimap for each of
values , all using the same key,
key . |
boolean |
putAll(Multimap<? extends K,? extends V> multimap)
Stores all key-value pairs of
multimap in this multimap, in the order returned by
multimap.entries() . |
boolean |
remove(java.lang.Object key,
java.lang.Object value)
Removes a single key-value pair with the key
key and the value value from this
multimap, if such exists. |
java.util.Collection<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.
|
java.lang.String |
toString()
Returns a string representation of the multimap, generated by calling
toString on the
map returned by Multimap.asMap() . |
(package private) java.util.Iterator<V> |
valueIterator() |
java.util.Collection<V> |
values()
Returns a view collection containing the value from each key-value pair contained in
this multimap, without collapsing duplicates (so
values().size() == size() ). |
(package private) java.util.Spliterator<V> |
valueSpliterator() |
private transient java.util.Set<K> keySet
private transient java.util.Collection<V> values
public boolean isEmpty()
Multimap
true
if this multimap contains no key-value pairs. Equivalent to size()
== 0
, but can in some cases be more efficient.public boolean containsValue(java.lang.Object value)
Multimap
true
if this multimap contains at least one key-value pair with the value
value
.containsValue
in interface Multimap<K,V>
public boolean containsEntry(java.lang.Object key, java.lang.Object value)
Multimap
true
if this multimap contains at least one key-value pair with the key key
and the value value
.containsEntry
in interface Multimap<K,V>
public boolean remove(java.lang.Object key, java.lang.Object value)
Multimap
key
and the value value
from this
multimap, if such exists. If multiple key-value pairs in the multimap fit this description,
which one is removed is unspecified.public boolean put(K key, V value)
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.
public boolean putAll(K key, java.lang.Iterable<? extends V> values)
Multimap
values
, 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.
public boolean putAll(Multimap<? extends K,? extends V> multimap)
Multimap
multimap
in this multimap, in the order returned by
multimap.entries()
.public java.util.Collection<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
Multimap
If values
is empty, this is equivalent to removeAll(key)
.
replaceValues
in interface Multimap<K,V>
public java.util.Collection<java.util.Map.Entry<K,V>> entries()
Multimap
Map.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.
public java.util.Set<K> keySet()
Multimap
Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible.
abstract java.util.Set<K> createKeySet()
public Multiset<K> keys()
Multimap
keys().count(k) == get(k).size()
for all k
.
Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
public java.util.Collection<V> values()
Multimap
values().size() == size()
).
Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
abstract java.util.Collection<V> createValues()
java.util.Iterator<V> valueIterator()
java.util.Spliterator<V> valueSpliterator()
public java.util.Map<K,java.util.Collection<V>> asMap()
Multimap
Map
from each distinct key to the nonempty
collection of that key's associated values. Note that this.asMap().get(k)
is equivalent
to this.get(k)
only when k
is a key contained in the multimap; otherwise it
returns null
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
or putAll
,
nor do its entries support setValue
.
public boolean equals(java.lang.Object object)
Multimap
Multimap.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 two ListMultimap
instances depends on the
ordering of the values for each key.
A non-empty SetMultimap
cannot be equal to a non-empty ListMultimap
, since
their Multimap.asMap()
views contain unequal collections as values. However, any two empty
multimaps are equal, because they both have empty Multimap.asMap()
views.
public int hashCode()
The hash code of a multimap is defined as the hash code of the map view, as returned by
Multimap.asMap()
.
public java.lang.String toString()
toString
on the
map returned by Multimap.asMap()
.toString
in class java.lang.Object