Package com.google.common.collect

Class ForwardingMultiset.StandardElementSet

<E>

<E>

com.google.common.collect.ForwardingMultiset.StandardElementSet

All Implemented Interfaces:

<E>, <E>, <E>

Enclosing class:

ForwardingMultiset<E>

@Beta
protected class ForwardingMultiset.StandardElementSet
extends <E>

A sensible implementation of Multiset.elementSet() in terms of the following methods: and methods of ForwardingMultiset.entrySet(), and ForwardingMultiset.remove(Object, int). In many situations, you may wish to override ForwardingMultiset.elementSet() to forward to this implementation or a subclass thereof.

Since:

10.0

Constructor Summary

Constructors

Constructor	Description
StandardElementSet()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the elements from this collection (optional operation).
boolean	o)	Returns true if this collection contains the specified element.
boolean	<?> c)	Returns true if this collection contains all of the elements in the specified collection.
boolean	isEmpty()	Returns true if this collection contains no elements.
<E>	iterator()	Returns an iterator over the elements contained in this collection.
boolean	o)	Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	<?> c)	Removes from this set all of its elements that are contained in the specified collection (optional operation).
boolean	<?> c)	Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size()	Returns the number of elements in this collection.

Methods inherited from class java.util.

,

Methods inherited from class java.util.

, , , ,

Methods inherited from class java.lang.

, , , , , , ,

Methods inherited from interface java.util.

, , ,

Methods inherited from interface java.lang.

Methods inherited from interface java.util.

, , , ,

Constructor Detail

StandardElementSet

public StandardElementSet()

Constructor for use by subclasses.

Method Detail

iterator

public <E> iterator()

Description copied from class:

Returns an iterator over the elements contained in this collection.

Specified by:

in interface <E>

Specified by:

in interface <E>

Specified by:

in interface <E>

Returns:

an iterator over the elements contained in this collection

clear

public void clear()

Description copied from class:

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

contains

public boolean contains( o)

Description copied from class:

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

containsAll

public boolean containsAll(<?> c)

Description copied from class:

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Parameters:

c - collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

See Also:

isEmpty

public boolean isEmpty()

Description copied from class:

Returns true if this collection contains no elements.

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Returns:

true if this collection contains no elements

remove

public boolean remove( o)

Description copied from class:

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Parameters:

o - element to be removed from this collection, if present

Returns:

true if an element was removed as a result of this call

size

public int size()

Description copied from interface:

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

in interface <E>

Specified by:

in interface <E>

Specified by:

in class <E>

Returns:

the number of elements in this collection

removeAll

public boolean removeAll(<?> c)

Description copied from class:

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Parameters:

c - collection containing elements to be removed from this set

Returns:

true if this set changed as a result of the call

See Also:

,

retainAll

public boolean retainAll(<?> c)

Description copied from class:

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

in interface <E>

Specified by:

in interface <E>

Overrides:

in class <E>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

See Also:

,