|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ArrayListMultimap<K,V>
@GwtCompatible(serializable=true,
emulated=true)
public final class ArrayListMultimap<K,V>
Implementation of Multimap that uses an ArrayList to store
the values for a given key. A HashMap associates each key with an
ArrayList of values.
When iterating through the collections supplied by this class, the ordering of values for a given key agrees with the order in which the values were added.
This multimap allows duplicate key-value pairs. After adding a new
key-value pair equal to an existing key-value pair, the ArrayListMultimap will contain entries for both the new value and the old
value.
Keys and values may be null. All optional multimap methods are supported, and all returned views are modifiable.
The lists returned by get(K), removeAll(java.lang.Object), and replaceValues(K, java.lang.Iterable extends V>) all implement RandomAccess.
This class is not threadsafe when any concurrent operations update the
multimap. Concurrent read operations will work correctly. To allow concurrent
update operations, wrap your multimap with a call to Multimaps.synchronizedListMultimap(com.google.common.collect.ListMultimap.
| 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. |
|
static
|
create()
Creates a new, empty ArrayListMultimap with the default initial
capacities. |
|
static
|
create(int expectedKeys,
int expectedValuesPerKey)
Constructs an empty ArrayListMultimap with enough capacity to hold
the specified numbers of keys and values without resizing. |
|
static
|
create(Multimap<? extends K,? extends V> multimap)
Constructs an ArrayListMultimap with the same mappings as the
specified multimap. |
|
Collection<Map.Entry<K,V>> |
entries()
Returns a collection of all key-value pairs. |
|
boolean |
equals(Object object)
Compares the specified object to this multimap for equality. |
|
List<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. |
|
List<V> |
removeAll(Object key)
Removes all values associated with a given key. |
|
List<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. |
|
String |
toString()
Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.asMap(). |
|
void |
trimToSize()
Reduces the memory used by this ArrayListMultimap, if feasible. |
|
Collection<V> |
values()
Returns a collection of all values in the multimap. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.common.collect.Multimap |
|---|
clear, containsEntry, containsKey, containsValue, entries, hashCode, isEmpty, keys, keySet, putAll, putAll, remove, size, values |
| Method Detail |
|---|
public static <K,V> ArrayListMultimap<K,V> create()
ArrayListMultimap with the default initial
capacities.
public static <K,V> ArrayListMultimap<K,V> create(int expectedKeys,
int expectedValuesPerKey)
ArrayListMultimap with enough capacity to hold
the specified numbers of keys and values without resizing.
expectedKeys - the expected number of distinct keysexpectedValuesPerKey - the expected average number of values per key
IllegalArgumentException - if expectedKeys or expectedValuesPerKey is negativepublic static <K,V> ArrayListMultimap<K,V> create(Multimap<? extends K,? extends V> multimap)
ArrayListMultimap with the same mappings as the
specified multimap.
multimap - the multimap whose contents are copied to this multimappublic void trimToSize()
ArrayListMultimap, if feasible.
public List<V> get(@Nullable
K key)
Changes to the returned collection will update the underlying multimap, and vice versa.
The returned collection is not serializable.
Because the values for a given key may have duplicates and follow the
insertion ordering, this method returns a List, instead of the
Collection specified in the Multimap interface.
get in interface ListMultimap<K,V>get in interface Multimap<K,V>key - key to search for in multimap
public List<V> removeAll(@Nullable
Object key)
The returned collection is immutable.
Because the values for a given key may have duplicates and follow the
insertion ordering, this method returns a List, instead of the
Collection specified in the Multimap interface.
removeAll in interface ListMultimap<K,V>removeAll in interface Multimap<K,V>key - key of entries to remove from the multimap
public List<V> replaceValues(@Nullable
K key,
Iterable<? extends V> values)
The returned collection is immutable.
Because the values for a given key may have duplicates and follow the
insertion ordering, this method returns a List, instead of the
Collection specified in the Multimap interface.
replaceValues in interface ListMultimap<K,V>replaceValues in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
public boolean put(@Nullable
K key,
@Nullable
V value)
put in interface Multimap<K,V>key - key to store in the multimapvalue - value to store in the multimap
true alwayspublic Map<K,Collection<V>> asMap()
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.
Though the method signature doesn't say so explicitly, the returned map
has List values.
asMap in interface ListMultimap<K,V>asMap in interface Multimap<K,V>
public boolean equals(@Nullable
Object object)
Two ListMultimap instances are equal if, for each key, they
contain the same values in the same order. If the value orderings disagree,
the multimaps will not be considered equal.
equals in interface ListMultimap<K,V>equals in interface Multimap<K,V>public int size()
Multimap
size in interface Multimap<K,V>public boolean isEmpty()
Multimaptrue if the multimap contains no key-value pairs.
isEmpty in interface Multimap<K,V>
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 multimap
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 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 boolean putAll(@Nullable
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 changedpublic void clear()
Multimap
clear in interface Multimap<K,V>public Set<K> keySet()
Multimap
keySet in interface Multimap<K,V>public Multiset<K> keys()
Multimap
keys in interface Multimap<K,V>public Collection<V> values()
The iterator generated by the returned collection traverses the values for one key, followed by the values of a second key, and so on.
values in interface Multimap<K,V>public Collection<Map.Entry<K,V>> entries()
add or addAll operations.
The iterator generated by the returned collection traverses the values for one key, followed by the values of a second key, and so on.
Each entry is an immutable snapshot of a key-value mapping in the multimap, taken at the time the entry is returned by a method call to the collection or its iterator.
entries in interface Multimap<K,V>public int hashCode()
The 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 ObjectMap.hashCode()public String toString()
toString on the map returned by Multimap.asMap().
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||