Class DescendingMultiset<E>
- All Implemented Interfaces:
Multiset<E>
,SortedIterable<E>
,SortedMultiset<E>
,SortedMultisetBridge<E>
,Iterable<E>
,Collection<E>
- Direct Known Subclasses:
ForwardingSortedMultiset.StandardDescendingMultiset
forwardMultiset()
and
entryIterator()
.-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMultiset
ForwardingMultiset.StandardElementSet
Nested classes/interfaces inherited from interface com.google.common.collect.Multiset
Multiset.Entry<E>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Comparator
<? super E> private NavigableSet
<E> private Set
<Multiset.Entry<E>> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionComparator
<? super E> Returns the comparator that orders this multiset, orOrdering.natural()
if the natural ordering of the elements is used.(package private) Set
<Multiset.Entry<E>> delegate()
Returns the backing delegate instance that methods are forwarded to.Returns a descending view of this multiset.Returns the set of distinct elements contained in this multiset.(package private) abstract Iterator
<Multiset.Entry<E>> entrySet()
Returns a view of the contents of this multiset, grouped intoMultiset.Entry
instances, each providing an element of the multiset and the count of that element.Returns the entry of the first element in this multiset, ornull
if this multiset is empty.(package private) abstract SortedMultiset
<E> headMultiset
(E toElement, BoundType boundType) Returns a view of this multiset restricted to the elements less thanupperBound
, optionally includingupperBound
itself.iterator()
Returns the entry of the last element in this multiset, ornull
if this multiset is empty.Returns and removes the entry associated with the lowest element in this multiset, or returnsnull
if this multiset is empty.Returns and removes the entry associated with the greatest element in this multiset, or returnsnull
if this multiset is empty.subMultiset
(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType) Returns a view of this multiset restricted to the range betweenlowerBound
andupperBound
.tailMultiset
(E fromElement, BoundType boundType) Returns a view of this multiset restricted to the elements greater thanlowerBound
, optionally includinglowerBound
itself.Object[]
toArray()
<T> T[]
toArray
(T[] array) toString()
Returns the string representation generated by the delegate'stoString
method.Methods inherited from class com.google.common.collect.ForwardingMultiset
add, count, equals, hashCode, remove, setCount, setCount, standardAdd, standardAddAll, standardClear, standardContains, standardCount, standardEquals, standardHashCode, standardIterator, standardRemove, standardRemoveAll, standardRetainAll, standardSetCount, standardSetCount, standardSize, standardToString
Methods inherited from class com.google.common.collect.ForwardingCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray
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
-
Field Details
-
comparator
-
elementSet
-
entrySet
-
-
Constructor Details
-
DescendingMultiset
DescendingMultiset()
-
-
Method Details
-
forwardMultiset
-
comparator
Description copied from interface:SortedMultiset
Returns the comparator that orders this multiset, orOrdering.natural()
if the natural ordering of the elements is used.- Specified by:
comparator
in interfaceSortedIterable<E>
- Specified by:
comparator
in interfaceSortedMultiset<E>
-
elementSet
Description copied from interface:Multiset
Returns 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:
elementSet
in interfaceMultiset<E>
- Specified by:
elementSet
in interfaceSortedMultiset<E>
- Specified by:
elementSet
in interfaceSortedMultisetBridge<E>
- Overrides:
elementSet
in classForwardingMultiset<E>
- Returns:
- a view of the set of distinct elements in this multiset
-
pollFirstEntry
Description copied from interface:SortedMultiset
Returns and removes the entry associated with the lowest element in this multiset, or returnsnull
if this multiset is empty.- Specified by:
pollFirstEntry
in interfaceSortedMultiset<E>
-
pollLastEntry
Description copied from interface:SortedMultiset
Returns and removes the entry associated with the greatest element in this multiset, or returnsnull
if this multiset is empty.- Specified by:
pollLastEntry
in interfaceSortedMultiset<E>
-
headMultiset
Description copied from interface:SortedMultiset
Returns a view of this multiset restricted to the elements less thanupperBound
, optionally includingupperBound
itself. 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
IllegalArgumentException
on attempts to add elements outside its range.- Specified by:
headMultiset
in interfaceSortedMultiset<E>
-
subMultiset
public SortedMultiset<E> subMultiset(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType) Description copied from interface:SortedMultiset
Returns a view of this multiset restricted to the range betweenlowerBound
andupperBound
. 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
IllegalArgumentException
on attempts to add elements outside its range.This method is equivalent to
tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType)
.- Specified by:
subMultiset
in interfaceSortedMultiset<E>
-
tailMultiset
Description copied from interface:SortedMultiset
Returns a view of this multiset restricted to the elements greater thanlowerBound
, optionally includinglowerBound
itself. 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
IllegalArgumentException
on attempts to add elements outside its range.- Specified by:
tailMultiset
in interfaceSortedMultiset<E>
-
delegate
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingMultiset<E>
-
descendingMultiset
Description copied from interface:SortedMultiset
Returns a descending view of this multiset. Modifications made to either map will be reflected in the other.- Specified by:
descendingMultiset
in interfaceSortedMultiset<E>
-
firstEntry
Description copied from interface:SortedMultiset
Returns the entry of the first element in this multiset, ornull
if this multiset is empty.- Specified by:
firstEntry
in interfaceSortedMultiset<E>
-
lastEntry
Description copied from interface:SortedMultiset
Returns the entry of the last element in this multiset, ornull
if this multiset is empty.- Specified by:
lastEntry
in interfaceSortedMultiset<E>
-
entryIterator
-
entrySet
Description copied from interface:Multiset
Returns a view of the contents of this multiset, grouped intoMultiset.Entry
instances, each providing an element of the multiset and the count of that element. This set contains exactly one entry for each distinct element in the multiset (thus it always has the same size as theMultiset.elementSet()
). The order of the elements in the element set is unspecified.The entry set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. However, multiset changes may or may not be reflected in any
Entry
instances already retrieved from the entry set (this is implementation-dependent). Furthermore, implementations are not required to support modifications to the entry set at all, and theEntry
instances themselves don't even have methods for modification. See the specific implementation class for more details on how its entry set handles modifications.- Specified by:
entrySet
in interfaceMultiset<E>
- Specified by:
entrySet
in interfaceSortedMultiset<E>
- Overrides:
entrySet
in classForwardingMultiset<E>
- Returns:
- a set of entries representing the data of this multiset
-
createEntrySet
Set<Multiset.Entry<E>> createEntrySet() -
iterator
Description copied from interface:SortedMultiset
Elements that occur multiple times in the multiset will appear multiple times in this iterator, though not necessarily sequentially.
The iterator returns the elements in ascending order according to this multiset's comparator.
- Specified by:
iterator
in interfaceCollection<E>
- Specified by:
iterator
in interfaceIterable<E>
- Specified by:
iterator
in interfaceMultiset<E>
- Specified by:
iterator
in interfaceSortedIterable<E>
- Specified by:
iterator
in interfaceSortedMultiset<E>
- Overrides:
iterator
in classForwardingCollection<E>
-
toArray
- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classForwardingCollection<E>
-
toArray
public <T> T[] toArray(T[] array) - Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classForwardingCollection<E>
-
toString
Description copied from class:ForwardingObject
Returns the string representation generated by the delegate'stoString
method.- Specified by:
toString
in interfaceMultiset<E>
- Overrides:
toString
in classForwardingObject
-