|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMultimap<K,V>
@GwtCompatible public abstract class ForwardingMultimap<K,V>
A multimap which forwards all its method calls to another multimap. Subclasses should override one or more methods to modify the behavior of the backing multimap as desired per the decorator pattern.
| Constructor Summary | |
|---|---|
protected |
ForwardingMultimap()
Constructor for use by subclasses. |
| Method Summary | |
|---|---|
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)
Compares the specified object with this multimap for equality. |
Collection<V> |
get(K key)
Returns a collection view of all values associated with a key. |
int |
hashCode()
Returns the hash code for this multimap. |
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 a collection of values with the same key. |
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 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. |
| Methods inherited from class com.google.common.collect.ForwardingObject |
|---|
toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected ForwardingMultimap()
| Method Detail |
|---|
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.
asMap in interface Multimap<K,V>public void clear()
Multimap
clear in interface Multimap<K,V>
public 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 multimap
public 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 multimap
public 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.
entries in interface Multimap<K,V>
public Collection<V> get(@Nullable
K key)
MultimapChanges to the returned collection will update the underlying multimap, and vice versa.
get in interface Multimap<K,V>key - key to search for in multimap
public boolean isEmpty()
Multimaptrue if the multimap contains no key-value pairs.
isEmpty in interface Multimap<K,V>public Multiset<K> keys()
Multimap
keys in interface Multimap<K,V>public Set<K> keySet()
Multimap
keySet in interface Multimap<K,V>
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.
put in interface Multimap<K,V>key - key to store in the multimapvalue - value to store in the multimap
true if the method increased the size of the multimap, or
false if the multimap already contained the key-value pair and
doesn't allow duplicates
public boolean putAll(K key,
Iterable<? extends V> values)
Multimap
putAll in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
true if the multimap changedpublic boolean putAll(Multimap<? extends K,? extends V> multimap)
Multimapmultimap.entries().
putAll in interface Multimap<K,V>multimap - mappings to store in this multimap
true if the multimap changed
public boolean remove(@Nullable
Object key,
@Nullable
Object value)
Multimap
remove in interface Multimap<K,V>key - key of entry to remove from the multimapvalue - value of entry to remove the multimap
true if the multimap changed
public Collection<V> removeAll(@Nullable
Object key)
Multimap
removeAll in interface Multimap<K,V>key - key of entries to remove from the multimap
public Collection<V> replaceValues(K key,
Iterable<? extends V> values)
Multimap
replaceValues in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
public int size()
Multimap
size in interface Multimap<K,V>public Collection<V> values()
Multimap
values in interface Multimap<K,V>
public boolean equals(@Nullable
Object object)
MultimapMultimap.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.
equals in interface Multimap<K,V>equals in class Objectpublic int hashCode()
MultimapThe hash code of a multimap is defined as the hash code of the map view,
as returned by Multimap.asMap().
hashCode in interface Multimap<K,V>hashCode in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||