Package com.google.common.collect

Class FilteredKeyMultimap<K,V>

java.lang.Object

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

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

All Implemented Interfaces:

FilteredMultimap<K,V>, Multimap<K,V>

Direct Known Subclasses:

FilteredKeyListMultimap, FilteredKeySetMultimap

@GwtCompatible
class FilteredKeyMultimap<K,V>
extends AbstractMultimap<K,V>
implements FilteredMultimap<K,V>

Implementation of Multimaps.filterKeys(Multimap, Predicate).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	FilteredKeyMultimap.AddRejectingList<K,V>
(package private) static class	FilteredKeyMultimap.AddRejectingSet<K,V>
(package private) class	FilteredKeyMultimap.Entries

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

AbstractMultimap.EntrySet, AbstractMultimap.Values

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Predicate<? super K>	keyPredicate
(package private) Multimap<K,V>	unfiltered

Constructor Summary

Constructors

Constructor	Description
FilteredKeyMultimap(Multimap<K,V> unfiltered, Predicate<? super K> keyPredicate)

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all key-value pairs from the multimap, leaving it empty.
boolean	containsKey(java.lang.Object key)	Returns true if this multimap contains at least one key-value pair with the key key.
(package private) java.util.Map<K,java.util.Collection<V>>	createAsMap()
(package private) java.util.Collection<java.util.Map.Entry<K,V>>	createEntries()
(package private) Multiset<K>	createKeys()
(package private) java.util.Set<K>	createKeySet()
(package private) java.util.Collection<V>	createValues()
(package private) java.util.Iterator<java.util.Map.Entry<K,V>>	entryIterator()
Predicate<? super java.util.Map.Entry<K,V>>	entryPredicate()
java.util.Collection<V>	get(K key)	Returns a view collection of the values associated with key in this multimap, if any.
java.util.Collection<V>	removeAll(java.lang.Object key)	Removes all values associated with the key key.
int	size()	Returns the number of key-value pairs in this multimap.
Multimap<K,V>	unfiltered()
(package private) java.util.Collection<V>	unmodifiableEmptyCollection()

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

asMap, containsEntry, containsValue, entries, entrySpliterator, equals, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, replaceValues, toString, valueIterator, values, valueSpliterator

Methods inherited from class java.lang.Object

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

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

asMap, containsEntry, containsValue, entries, equals, forEach, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, replaceValues, values

Field Detail

unfiltered

final Multimap<K,V> unfiltered

keyPredicate

final Predicate<? super K> keyPredicate

Constructor Detail

FilteredKeyMultimap

FilteredKeyMultimap(Multimap<K,V> unfiltered,
                    Predicate<? super K> keyPredicate)

Method Detail

unfiltered

public Multimap<K,V> unfiltered()

Specified by:

unfiltered in interface FilteredMultimap<K,V>

entryPredicate

public Predicate<? super java.util.Map.Entry<K,V>> entryPredicate()

Specified by:

entryPredicate in interface FilteredMultimap<K,V>

size

public int size()

Description copied from interface: Multimap

Returns the number of key-value pairs in this multimap.

Note: this method does not return the number of distinct keys in the multimap, which is given by keySet().size() or asMap().size(). See the opening section of the Multimap class documentation for clarification.

Specified by:

size in interface Multimap<K,V>

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from interface: Multimap

Returns true if this multimap contains at least one key-value pair with the key key.

Specified by:

containsKey in interface Multimap<K,V>

removeAll

public java.util.Collection<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>

Returns:

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

unmodifiableEmptyCollection

java.util.Collection<V> unmodifiableEmptyCollection()

clear

public void clear()

Description copied from interface: Multimap

Removes all key-value pairs from the multimap, leaving it empty.

Specified by:

clear in interface Multimap<K,V>

createKeySet

java.util.Set<K> createKeySet()

Specified by:

createKeySet in class AbstractMultimap<K,V>

get

public java.util.Collection<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>

entryIterator

java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()

Specified by:

entryIterator in class AbstractMultimap<K,V>

createEntries

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

Specified by:

createEntries in class AbstractMultimap<K,V>

createValues

java.util.Collection<V> createValues()

Specified by:

createValues in class AbstractMultimap<K,V>

createAsMap

java.util.Map<K,java.util.Collection<V>> createAsMap()

Specified by:

createAsMap in class AbstractMultimap<K,V>

createKeys

Multiset<K> createKeys()

Specified by:

createKeys in class AbstractMultimap<K,V>