@GwtCompatible public abstract class ForwardingMultimap<K,V> extends ForwardingObject implements Multimap<K,V>
| Modifier | Constructor and Description |
|---|---|
protected |
ForwardingMultimap()
Constructor for use by subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
Map<K,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.
|
boolean |
containsEntry(Object key,
Object value)
Returns
true if the multimap contains the specified key-value pair. |
boolean |
containsKey(Object key)
Returns
true if the multimap contains any values for the specified
key. |
boolean |
containsValue(Object value)
Returns
true if the multimap contains the specified value for any
key. |
protected abstract Multimap<K,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
Collection<Map.Entry<K,V>> |
entries()
Returns a collection of all key-value pairs.
|
boolean |
equals(Object object)
Indicates whether some other object is "equal to" this one.
|
Collection<V> |
get(K key)
Returns a collection view containing the values associated with
key
in this multimap, if any. |
int |
hashCode()
Returns a hash code value for the object.
|
boolean |
isEmpty()
Returns
true if the multimap contains no key-value pairs. |
Multiset<K> |
keys()
Returns a collection, which may contain duplicates, of all keys.
|
Set<K> |
keySet()
Returns the set of all keys, each appearing once in the returned set.
|
boolean |
put(K key,
V value)
Stores a key-value pair in the multimap.
|
boolean |
putAll(K key,
Iterable<? extends V> values)
Stores key-value pairs in this multimap with one key and multiple values.
|
boolean |
putAll(Multimap<? extends K,? extends V> multimap)
Copies all of another multimap's key-value pairs into this multimap.
|
boolean |
remove(Object key,
Object value)
Removes a single key-value pair from the multimap.
|
Collection<V> |
removeAll(Object key)
Removes all values associated with a given key.
|
Collection<V> |
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 the multimap.
|
Collection<V> |
values()
Returns a collection of all values in the multimap.
|
toStringprotected ForwardingMultimap()
protected abstract Multimap<K,V> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply
the instance being decorated.delegate in class ForwardingObjectpublic Map<K,Collection<V>> asMap()
MultimapsetValue()
on its entries, put, or putAll.
When passed a key that is present in the map, asMap().get(Object) has the same behavior as Multimap.get(K), returning a
live collection. When passed a key that is not present, however, asMap().get(Object) returns null instead of an empty collection.
public void clear()
Multimappublic boolean containsEntry(@Nullable Object key, @Nullable Object value)
Multimaptrue if the multimap contains the specified key-value pair.containsEntry in interface Multimap<K,V>key - key to search for in multimapvalue - value to search for in multimappublic boolean containsKey(@Nullable Object key)
Multimaptrue if the multimap contains any values for the specified
key.containsKey in interface Multimap<K,V>key - key to search for in multimappublic boolean containsValue(@Nullable Object value)
Multimaptrue if the multimap contains the specified value for any
key.containsValue in interface Multimap<K,V>value - value to search for in multimappublic Collection<Map.Entry<K,V>> entries()
Multimapadd or addAll operations.public Collection<V> get(@Nullable K key)
Multimapkey
in this multimap, if any. Note that even when (containsKey(key) is
false, get(key) still returns an empty collection, not null.
Changes to the returned collection will update the underlying multimap, and vice versa.
public boolean isEmpty()
Multimaptrue if the multimap contains no key-value pairs.public Multiset<K> keys()
Multimappublic Set<K> keySet()
MultimapNote that the key set contains a key if and only if this multimap maps that key to at least one value.
public boolean put(K key, V value)
MultimapSome 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, Iterable<? extends V> values)
MultimapThis is equivalent to
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)
Multimapmultimap.entries().public boolean remove(@Nullable Object key, @Nullable Object value)
Multimappublic Collection<V> removeAll(@Nullable Object key)
MultimapOnce this method returns, key will not be mapped to any values,
so it will not appear in Multimap.keySet(), Multimap.asMap(), or any other
views.
removeAll in interface Multimap<K,V>key - key of entries to remove from the multimappublic Collection<V> replaceValues(K key, Iterable<? extends V> values)
MultimapIf values is empty, this is equivalent to
removeAll(key).
replaceValues in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimappublic int size()
Multimappublic Collection<V> values()
Multimappublic boolean equals(@Nullable Object object)
java.lang.Object
The equals method implements an equivalence relation
on non-null object references:
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
public int hashCode()
java.lang.ObjectHashMap.
The general contract of hashCode is:
hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
hashCode in interface Multimap<K,V>hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)Copyright © 2010-2013. All Rights Reserved.