|
||||||||||
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)
Indicates whether some other object is "equal to" this one. |
Collection<V> |
get(K key)
Returns a collection view of all values associated with a key. |
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 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()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.
delegate
in class ForwardingObject
public Map<K,Collection<V>> asMap()
Multimap
setValue()
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)
Multimap
true
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)
Multimap
true
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)
Multimap
true
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()
Multimap
add
or addAll
operations.
entries
in interface Multimap<K,V>
public Collection<V> get(@Nullable K key)
Multimap
Changes 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()
Multimap
true
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)
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.
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 duplicatespublic 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)
Multimap
multimap.entries()
.
putAll
in interface Multimap<K,V>
multimap
- mappings to store in this multimap
true
if the multimap changedpublic 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 changedpublic 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)
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.
equals
in interface Multimap<K,V>
equals
in class Object
object
- the reference object with which to compare.
true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
Hashtable
public int hashCode()
java.lang.Object
java.util.Hashtable
.
The general contract of hashCode
is:
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 hashtables.
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 Object
Object.equals(java.lang.Object)
,
Hashtable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |