com.google.common.collect

Class FilteredEntrySetMultimap<K,V>

java.lang.Object

com.google.common.collect.AbstractMultimap<K,V>

com.google.common.collect.FilteredEntryMultimap<K,V>

com.google.common.collect.FilteredEntrySetMultimap<K,V>

All Implemented Interfaces:

FilteredMultimap<K,V>, FilteredSetMultimap<K,V>, Multimap<K,V>, SetMultimap<K,V>

@GwtCompatible
final class FilteredEntrySetMultimap<K,V>
extends FilteredEntryMultimap<K,V>
implements FilteredSetMultimap<K,V>

Implementation of Multimaps.filterEntries(SetMultimap, Predicate).

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.FilteredEntryMultimap

FilteredEntryMultimap.AsMap, FilteredEntryMultimap.Keys, FilteredEntryMultimap.ValuePredicate

Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap

AbstractMultimap.Values

Field Summary

Fields inherited from class com.google.common.collect.FilteredEntryMultimap

predicate, unfiltered

Constructor Summary

Constructors

Constructor and Description
FilteredEntrySetMultimap(SetMultimap<K,V> unfiltered, Predicate<? super java.util.Map.Entry<K,V>> predicate)

Method Summary

Modifier and Type	Method and Description
(package private) java.util.Set<java.util.Map.Entry<K,V>>	createEntries()
java.util.Set<java.util.Map.Entry<K,V>>	entries() Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.
java.util.Set<V>	get(K key) Returns a view collection of the values associated with key in this multimap, if any.
java.util.Set<V>	removeAll(java.lang.Object key) Removes all values associated with the key key.
java.util.Set<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.
SetMultimap<K,V>	unfiltered()

Methods inherited from class com.google.common.collect.FilteredEntryMultimap

clear, containsKey, createAsMap, createKeys, createValues, entryIterator, entryPredicate, filterCollection, keySet, removeEntriesIf, size, unmodifiableEmptyCollection

Methods inherited from class com.google.common.collect.AbstractMultimap

asMap, containsEntry, containsValue, createKeySet, equals, hashCode, isEmpty, keys, put, putAll, putAll, remove, toString, valueIterator, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.collect.FilteredMultimap

entryPredicate

Methods inherited from interface com.google.common.collect.SetMultimap

asMap, equals

Methods inherited from interface com.google.common.collect.Multimap

clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values

Constructor Detail

FilteredEntrySetMultimap

FilteredEntrySetMultimap(SetMultimap<K,V> unfiltered,
                         Predicate<? super java.util.Map.Entry<K,V>> predicate)

Method Detail

unfiltered

public SetMultimap<K,V> unfiltered()

Specified by:

unfiltered in interface FilteredMultimap<K,V>

Specified by:

unfiltered in interface FilteredSetMultimap<K,V>

Overrides:

unfiltered in class FilteredEntryMultimap<K,V>

get

public java.util.Set<V> get(K key)

Description copied from interface: Multimap

Returns a view collection of the values associated with key in this multimap, if any. Note that when containsKey(key) is false, this returns an empty collection, not null.

Changes to the returned collection will update the underlying multimap, and vice versa.

Specified by:

get in interface Multimap<K,V>

Specified by:

get in interface SetMultimap<K,V>

Overrides:

get in class FilteredEntryMultimap<K,V>

removeAll

public java.util.Set<V> removeAll(java.lang.Object key)

Description copied from interface: Multimap

Removes all values associated with the key key.

Once 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.

Specified by:

removeAll in interface Multimap<K,V>

Specified by:

removeAll in interface SetMultimap<K,V>

Overrides:

removeAll in class FilteredEntryMultimap<K,V>

Returns:

the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

replaceValues

public java.util.Set<V> replaceValues(K key,
                                      java.lang.Iterable<? extends V> values)

Description copied from interface: Multimap

Stores a collection of values with the same key, replacing any existing values for that key.

If values is empty, this is equivalent to removeAll(key).

Specified by:

replaceValues in interface Multimap<K,V>

Specified by:

replaceValues in interface SetMultimap<K,V>

Overrides:

replaceValues in class AbstractMultimap<K,V>

Returns:

the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.

createEntries

java.util.Set<java.util.Map.Entry<K,V>> createEntries()

Overrides:

createEntries in class FilteredEntryMultimap<K,V>

entries

public java.util.Set<java.util.Map.Entry<K,V>> entries()

Description copied from interface: Multimap

Returns a view collection of all key-value pairs contained in this multimap, as 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.

Specified by:

entries in interface Multimap<K,V>

Specified by:

entries in interface SetMultimap<K,V>

Overrides:

entries in class AbstractMultimap<K,V>