Class ForwardingMultiset.StandardElementSet
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractSet<E>
-
- com.google.common.collect.ForwardingMultiset.StandardElementSet
-
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,Set<E>
- Enclosing class:
- ForwardingMultiset<E extends @Nullable Object>
@Beta protected class ForwardingMultiset.StandardElementSet extends AbstractSet<E>
A sensible implementation ofMultiset.elementSet()
in terms of the following methods:ForwardingCollection.clear()
,ForwardingCollection.contains(java.lang.Object)
,ForwardingCollection.containsAll(java.util.Collection<?>)
,ForwardingMultiset.count(java.lang.Object)
,ForwardingCollection.isEmpty()
, theSet.size()
andSet.iterator()
methods ofForwardingMultiset.entrySet()
, andForwardingMultiset.remove(Object, int)
. In many situations, you may wish to overrideForwardingMultiset.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all of the elements from this collection (optional operation).boolean
contains(Object o)
Returnstrue
if this collection contains the specified element.boolean
containsAll(Collection<?> c)
Returnstrue
if this collection contains all of the elements in the specified collection.boolean
isEmpty()
Returnstrue
if this collection contains no elements.Iterator<E>
iterator()
Returns an iterator over the elements contained in this collection.boolean
remove(Object o)
Removes a single instance of the specified element from this collection, if it is present (optional operation).boolean
removeAll(Collection<?> c)
Removes from this set all of its elements that are contained in the specified collection (optional operation).boolean
retainAll(Collection<?> 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.AbstractSet
equals, hashCode
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
-
-
-
Constructor Detail
-
StandardElementSet
public StandardElementSet()
Constructor for use by subclasses.
-
-
Method Detail
-
iterator
public Iterator<E> iterator()
Description copied from class:java.util.AbstractCollection
Returns an iterator over the elements contained in this collection.
-
clear
public void clear()
Description copied from class:java.util.AbstractCollection
Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.
-
contains
public boolean contains(@CheckForNull Object o)
Description copied from class:java.util.AbstractCollection
Returnstrue
if this collection contains the specified element. More formally, returnstrue
if and only if this collection contains at least one elemente
such thatObjects.equals(o, e)
.- Specified by:
contains
in interfaceCollection<E extends @Nullable Object>
- Specified by:
contains
in interfaceSet<E extends @Nullable Object>
- Overrides:
contains
in classAbstractCollection<E extends @Nullable Object>
- 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(Collection<?> c)
Description copied from class:java.util.AbstractCollection
Returnstrue
if this collection contains all of the elements in the specified collection.- Specified by:
containsAll
in interfaceCollection<E extends @Nullable Object>
- Specified by:
containsAll
in interfaceSet<E extends @Nullable Object>
- Overrides:
containsAll
in classAbstractCollection<E extends @Nullable Object>
- 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:
AbstractCollection.contains(Object)
-
isEmpty
public boolean isEmpty()
Description copied from class:java.util.AbstractCollection
Returnstrue
if this collection contains no elements.
-
remove
public boolean remove(@CheckForNull Object o)
Description copied from class:java.util.AbstractCollection
Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an elemente
such thatObjects.equals(o, e)
, if this collection contains one or more such elements. Returnstrue
if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).- Specified by:
remove
in interfaceCollection<E extends @Nullable Object>
- Specified by:
remove
in interfaceSet<E extends @Nullable Object>
- Overrides:
remove
in classAbstractCollection<E extends @Nullable Object>
- 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:java.util.Collection
Returns the number of elements in this collection. If this collection contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
removeAll
public boolean removeAll(Collection<?> c)
Description copied from class:java.util.AbstractSet
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'sremove
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'sremove
method.Note that this implementation will throw an
UnsupportedOperationException
if the iterator returned by theiterator
method does not implement theremove
method.- Specified by:
removeAll
in interfaceCollection<E extends @Nullable Object>
- Specified by:
removeAll
in interfaceSet<E extends @Nullable Object>
- Overrides:
removeAll
in classAbstractSet<E extends @Nullable Object>
- 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:
AbstractCollection.remove(Object)
,AbstractCollection.contains(Object)
-
retainAll
public boolean retainAll(Collection<?> c)
Description copied from class:java.util.AbstractCollection
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:
retainAll
in interfaceCollection<E extends @Nullable Object>
- Specified by:
retainAll
in interfaceSet<E extends @Nullable Object>
- Overrides:
retainAll
in classAbstractCollection<E extends @Nullable Object>
- 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:
AbstractCollection.remove(Object)
,AbstractCollection.contains(Object)
-
-