com.google.common.collect

Class Multisets.FilteredMultiset<E>

java.lang.Object

java.util.AbstractCollection<E>

com.google.common.collect.AbstractMultiset<E>

com.google.common.collect.Multisets.FilteredMultiset<E>

All Implemented Interfaces:

Multiset<E>, java.lang.Iterable<E>, java.util.Collection<E>

Enclosing class:

Multisets

private static final class Multisets.FilteredMultiset<E>
extends AbstractMultiset<E>

Nested Class Summary

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

AbstractMultiset.ElementSet, AbstractMultiset.EntrySet

Nested classes/interfaces inherited from interface com.google.common.collect.Multiset

Multiset.Entry<E>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Predicate<? super E>	predicate
(package private) Multiset<E>	unfiltered

Constructor Summary

Constructors

Constructor and Description
FilteredMultiset(Multiset<E> unfiltered, Predicate<? super E> predicate)

Method Summary

Modifier and Type	Method and Description
int	add(E element, int occurrences) Adds a number of occurrences of an element to this multiset.
void	clear()
int	count(java.lang.Object element) Returns the number of occurrences of an element in this multiset (the count of the element).
(package private) java.util.Set<E>	createElementSet() Creates a new instance of this multiset's element set, which will be returned by AbstractMultiset.elementSet().
(package private) java.util.Set<Multiset.Entry<E>>	createEntrySet()
(package private) int	distinctElements()
(package private) java.util.Iterator<Multiset.Entry<E>>	entryIterator()
UnmodifiableIterator<E>	iterator()
int	remove(java.lang.Object element, int occurrences) Removes a number of occurrences of the specified element from this multiset.

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

add, addAll, contains, elementSet, entrySet, equals, hashCode, isEmpty, remove, removeAll, retainAll, setCount, setCount, size, toString

Methods inherited from class java.util.AbstractCollection

containsAll, toArray, toArray

Methods inherited from class java.lang.Object

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

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

containsAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

unfiltered

final Multiset<E> unfiltered

predicate

final Predicate<? super E> predicate

Constructor Detail

FilteredMultiset

FilteredMultiset(Multiset<E> unfiltered,
                 Predicate<? super E> predicate)

Method Detail

iterator

public UnmodifiableIterator<E> iterator()

Description copied from interface: Multiset

Elements that occur multiple times in the multiset will appear multiple times in this iterator, though not necessarily sequentially.

Specified by:

iterator in interface Multiset<E>

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Overrides:

iterator in class AbstractMultiset<E>

createElementSet

java.util.Set<E> createElementSet()

Description copied from class: AbstractMultiset

Creates a new instance of this multiset's element set, which will be returned by AbstractMultiset.elementSet().

Overrides:

createElementSet in class AbstractMultiset<E>

createEntrySet

java.util.Set<Multiset.Entry<E>> createEntrySet()

Overrides:

createEntrySet in class AbstractMultiset<E>

entryIterator

java.util.Iterator<Multiset.Entry<E>> entryIterator()

Specified by:

entryIterator in class AbstractMultiset<E>

distinctElements

int distinctElements()

Specified by:

distinctElements in class AbstractMultiset<E>

count

public int count(@Nullable
                 java.lang.Object element)

Description copied from interface: Multiset

Returns the number of occurrences of an element in this multiset (the count of the element). Note that for an Object.equals(java.lang.Object)-based multiset, this gives the same result as Collections.frequency(java.util.Collection<?>, java.lang.Object) (which would presumably perform more poorly).

Note: the utility method Iterables.frequency(java.lang.Iterable<?>, java.lang.Object) generalizes this operation; it correctly delegates to this method when dealing with a multiset, but it can also accept any other iterable type.

Specified by:

count in interface Multiset<E>

Overrides:

count in class AbstractMultiset<E>

Parameters:

element - the element to count occurrences of

Returns:

the number of occurrences of the element in this multiset; possibly zero but never negative

add

public int add(@Nullable
               E element,
               int occurrences)

Description copied from interface: Multiset

Adds a number of occurrences of an element to this multiset. Note that if occurrences == 1, this method has the identical effect to Multiset.add(Object). This method is functionally equivalent (except in the case of overflow) to the call addAll(Collections.nCopies(element, occurrences)), which would presumably perform much more poorly.

Specified by:

add in interface Multiset<E>

Overrides:

add in class AbstractMultiset<E>

Parameters:

element - the element to add occurrences of; may be null only if explicitly allowed by the implementation

occurrences - the number of occurrences of the element to add. May be zero, in which case no change will be made.

Returns:

the count of the element before the operation; possibly zero

remove

public int remove(@Nullable
                  java.lang.Object element,
                  int occurrences)

Description copied from interface: Multiset

Removes a number of occurrences of the specified element from this multiset. If the multiset contains fewer than this number of occurrences to begin with, all occurrences will be removed. Note that if occurrences == 1, this is functionally equivalent to the call remove(element).

Specified by:

remove in interface Multiset<E>

Overrides:

remove in class AbstractMultiset<E>

Parameters:

element - the element to conditionally remove occurrences of

occurrences - the number of occurrences of the element to remove. May be zero, in which case no change will be made.

Returns:

the count of the element before the operation; possibly zero

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Overrides:

clear in class AbstractMultiset<E>