Class AbstractSortedMultiset<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- com.google.common.collect.AbstractMultiset<E>
-
- com.google.common.collect.AbstractSortedMultiset<E>
-
- All Implemented Interfaces:
Multiset<E>,SortedIterable<E>,SortedMultiset<E>,SortedMultisetBridge<E>,java.lang.Iterable<E>,java.util.Collection<E>
- Direct Known Subclasses:
TreeMultiset
abstract class AbstractSortedMultiset<E> extends AbstractMultiset<E> implements SortedMultiset<E>
This class provides a skeletal implementation of theSortedMultisetinterface.The
Multiset.count(java.lang.Object)andAbstractCollection.size()implementations all iterate across the set returned byMultiset.entrySet(), as do many methods acting on the set returned byelementSet(). Override those methods for better performance.
-
-
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 Description (package private) java.util.Comparator<? super E>comparatorprivate SortedMultiset<E>descendingMultiset
-
Constructor Summary
Constructors Constructor Description AbstractSortedMultiset()AbstractSortedMultiset(java.util.Comparator<? super E> comparator)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Comparator<? super E>comparator()Returns the comparator that orders this multiset, orOrdering.natural()if the natural ordering of the elements is used.(package private) SortedMultiset<E>createDescendingMultiset()(package private) java.util.NavigableSet<E>createElementSet()Creates a new instance of this multiset's element set, which will be returned byAbstractMultiset.elementSet().(package private) abstract java.util.Iterator<Multiset.Entry<E>>descendingEntryIterator()(package private) java.util.Iterator<E>descendingIterator()SortedMultiset<E>descendingMultiset()Returns a descending view of this multiset.java.util.NavigableSet<E>elementSet()Returns the set of distinct elements contained in this multiset.Multiset.Entry<E>firstEntry()Returns the entry of the first element in this multiset, ornullif this multiset is empty.Multiset.Entry<E>lastEntry()Returns the entry of the last element in this multiset, ornullif this multiset is empty.Multiset.Entry<E>pollFirstEntry()Returns and removes the entry associated with the lowest element in this multiset, or returnsnullif this multiset is empty.Multiset.Entry<E>pollLastEntry()Returns and removes the entry associated with the greatest element in this multiset, or returnsnullif this multiset is empty.SortedMultiset<E>subMultiset(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType)Returns a view of this multiset restricted to the range betweenlowerBoundandupperBound.-
Methods inherited from class com.google.common.collect.AbstractMultiset
add, add, addAll, clear, contains, createEntrySet, distinctElements, elementIterator, entryIterator, entrySet, equals, hashCode, isEmpty, remove, remove, removeAll, retainAll, setCount, setCount, toString
-
Methods inherited from class java.util.AbstractCollection
containsAll, iterator, size, toArray, toArray
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
addAll, clear, isEmpty, parallelStream, removeIf, stream, toArray, toArray, toArray
-
Methods inherited from interface com.google.common.collect.Multiset
add, add, contains, containsAll, count, equals, forEach, forEachEntry, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, size, spliterator, toString
-
Methods inherited from interface com.google.common.collect.SortedMultiset
entrySet, headMultiset, iterator, tailMultiset
-
-
-
-
Field Detail
-
comparator
@GwtTransient final java.util.Comparator<? super E> comparator
-
descendingMultiset
private transient SortedMultiset<E> descendingMultiset
-
-
Constructor Detail
-
AbstractSortedMultiset
AbstractSortedMultiset()
-
AbstractSortedMultiset
AbstractSortedMultiset(java.util.Comparator<? super E> comparator)
-
-
Method Detail
-
elementSet
public java.util.NavigableSet<E> elementSet()
Description copied from interface:MultisetReturns the set of distinct elements contained in this multiset. The element set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. The order of the elements in the element set is unspecified.If the element set supports any removal operations, these necessarily cause all occurrences of the removed element(s) to be removed from the multiset. Implementations are not expected to support the add operations, although this is possible.
A common use for the element set is to find the number of distinct elements in the multiset:
elementSet().size().- Specified by:
elementSetin interfaceMultiset<E>- Specified by:
elementSetin interfaceSortedMultiset<E>- Specified by:
elementSetin interfaceSortedMultisetBridge<E>- Overrides:
elementSetin classAbstractMultiset<E>- Returns:
- a view of the set of distinct elements in this multiset
-
createElementSet
java.util.NavigableSet<E> createElementSet()
Description copied from class:AbstractMultisetCreates a new instance of this multiset's element set, which will be returned byAbstractMultiset.elementSet().- Overrides:
createElementSetin classAbstractMultiset<E>
-
comparator
public java.util.Comparator<? super E> comparator()
Description copied from interface:SortedMultisetReturns the comparator that orders this multiset, orOrdering.natural()if the natural ordering of the elements is used.- Specified by:
comparatorin interfaceSortedIterable<E>- Specified by:
comparatorin interfaceSortedMultiset<E>
-
firstEntry
public Multiset.Entry<E> firstEntry()
Description copied from interface:SortedMultisetReturns the entry of the first element in this multiset, ornullif this multiset is empty.- Specified by:
firstEntryin interfaceSortedMultiset<E>
-
lastEntry
public Multiset.Entry<E> lastEntry()
Description copied from interface:SortedMultisetReturns the entry of the last element in this multiset, ornullif this multiset is empty.- Specified by:
lastEntryin interfaceSortedMultiset<E>
-
pollFirstEntry
public Multiset.Entry<E> pollFirstEntry()
Description copied from interface:SortedMultisetReturns and removes the entry associated with the lowest element in this multiset, or returnsnullif this multiset is empty.- Specified by:
pollFirstEntryin interfaceSortedMultiset<E>
-
pollLastEntry
public Multiset.Entry<E> pollLastEntry()
Description copied from interface:SortedMultisetReturns and removes the entry associated with the greatest element in this multiset, or returnsnullif this multiset is empty.- Specified by:
pollLastEntryin interfaceSortedMultiset<E>
-
subMultiset
public SortedMultiset<E> subMultiset(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType)
Description copied from interface:SortedMultisetReturns a view of this multiset restricted to the range betweenlowerBoundandupperBound. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.The returned multiset will throw an
IllegalArgumentExceptionon attempts to add elements outside its range.This method is equivalent to
tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType).- Specified by:
subMultisetin interfaceSortedMultiset<E>
-
descendingEntryIterator
abstract java.util.Iterator<Multiset.Entry<E>> descendingEntryIterator()
-
descendingIterator
java.util.Iterator<E> descendingIterator()
-
descendingMultiset
public SortedMultiset<E> descendingMultiset()
Description copied from interface:SortedMultisetReturns a descending view of this multiset. Modifications made to either map will be reflected in the other.- Specified by:
descendingMultisetin interfaceSortedMultiset<E>
-
createDescendingMultiset
SortedMultiset<E> createDescendingMultiset()
-
-