@GwtCompatible(emulated=true) abstract class DescendingMultiset<E> extends ForwardingMultiset<E> implements SortedMultiset<E>
forwardMultiset()
and entryIterator()
.ForwardingMultiset.StandardElementSet
Multiset.Entry<E>
Modifier and Type | Field and Description |
---|---|
private java.util.Comparator<? super E> |
comparator |
private java.util.NavigableSet<E> |
elementSet |
private java.util.Set<Multiset.Entry<E>> |
entrySet |
Constructor and Description |
---|
DescendingMultiset() |
Modifier and Type | Method and Description |
---|---|
java.util.Comparator<? super E> |
comparator()
Returns the comparator that orders this multiset, or
Ordering.natural() if the natural ordering of the elements is used. |
(package private) java.util.Set<Multiset.Entry<E>> |
createEntrySet() |
protected Multiset<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
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.
|
(package private) abstract java.util.Iterator<Multiset.Entry<E>> |
entryIterator() |
java.util.Set<Multiset.Entry<E>> |
entrySet()
Returns a view of the contents of this multiset, grouped into
Multiset.Entry instances, each providing an element of the multiset and
the count of that element. |
Multiset.Entry<E> |
firstEntry()
Returns the entry of the first element in this multiset, or
null if
this multiset is empty. |
(package private) abstract SortedMultiset<E> |
forwardMultiset() |
SortedMultiset<E> |
headMultiset(E toElement,
BoundType boundType)
Returns a view of this multiset restricted to the elements less than
upperBound , optionally including upperBound itself. |
java.util.Iterator<E> |
iterator() |
Multiset.Entry<E> |
lastEntry()
Returns the entry of the last element in this multiset, or
null if
this multiset is empty. |
Multiset.Entry<E> |
pollFirstEntry()
Returns and removes the entry associated with the lowest element in this
multiset, or returns
null if this multiset is empty. |
Multiset.Entry<E> |
pollLastEntry()
Returns and removes the entry associated with the greatest element in this
multiset, or returns
null if 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 between
lowerBound and upperBound . |
SortedMultiset<E> |
tailMultiset(E fromElement,
BoundType boundType)
Returns a view of this multiset restricted to the elements greater than
lowerBound , optionally including lowerBound itself. |
java.lang.Object[] |
toArray() |
<T> T[] |
toArray(T[] array) |
java.lang.String |
toString()
Returns the string representation generated by the delegate's
toString method. |
add, count, equals, hashCode, remove, setCount, setCount, standardAdd, standardAddAll, standardClear, standardContains, standardCount, standardEquals, standardHashCode, standardIterator, standardRemove, standardRemoveAll, standardRetainAll, standardSetCount, standardSetCount, standardSize, standardToString
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
add, add, contains, containsAll, count, equals, hashCode, remove, remove, removeAll, retainAll, setCount, setCount
private transient java.util.Comparator<? super E> comparator
private transient java.util.NavigableSet<E> elementSet
private transient java.util.Set<Multiset.Entry<E>> entrySet
abstract SortedMultiset<E> forwardMultiset()
public java.util.Comparator<? super E> comparator()
SortedMultiset
Ordering.natural()
if the natural ordering of the elements is used.comparator
in interface SortedIterable<E>
comparator
in interface SortedMultiset<E>
public java.util.NavigableSet<E> elementSet()
Multiset
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()
.
elementSet
in interface Multiset<E>
elementSet
in interface SortedMultiset<E>
elementSet
in interface SortedMultisetBridge<E>
elementSet
in class ForwardingMultiset<E>
public Multiset.Entry<E> pollFirstEntry()
SortedMultiset
null
if this multiset is empty.pollFirstEntry
in interface SortedMultiset<E>
public Multiset.Entry<E> pollLastEntry()
SortedMultiset
null
if this multiset is empty.pollLastEntry
in interface SortedMultiset<E>
public SortedMultiset<E> headMultiset(E toElement, BoundType boundType)
SortedMultiset
upperBound
, optionally including upperBound
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.
headMultiset
in interface SortedMultiset<E>
public SortedMultiset<E> subMultiset(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType)
SortedMultiset
lowerBound
and upperBound
. 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)
.
subMultiset
in interface SortedMultiset<E>
public SortedMultiset<E> tailMultiset(E fromElement, BoundType boundType)
SortedMultiset
lowerBound
, optionally including lowerBound
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.
tailMultiset
in interface SortedMultiset<E>
protected Multiset<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.delegate
in class ForwardingMultiset<E>
public SortedMultiset<E> descendingMultiset()
SortedMultiset
descendingMultiset
in interface SortedMultiset<E>
public Multiset.Entry<E> firstEntry()
SortedMultiset
null
if
this multiset is empty.firstEntry
in interface SortedMultiset<E>
public Multiset.Entry<E> lastEntry()
SortedMultiset
null
if
this multiset is empty.lastEntry
in interface SortedMultiset<E>
abstract java.util.Iterator<Multiset.Entry<E>> entryIterator()
public java.util.Set<Multiset.Entry<E>> entrySet()
Multiset
Multiset.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 the
Multiset.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 the Entry
instances themselves don't
even have methods for modification. See the specific implementation class
for more details on how its entry set handles modifications.
entrySet
in interface Multiset<E>
entrySet
in interface SortedMultiset<E>
entrySet
in class ForwardingMultiset<E>
java.util.Set<Multiset.Entry<E>> createEntrySet()
public java.util.Iterator<E> iterator()
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.
iterator
in interface Multiset<E>
iterator
in interface SortedIterable<E>
iterator
in interface SortedMultiset<E>
iterator
in interface java.lang.Iterable<E>
iterator
in interface java.util.Collection<E>
iterator
in class ForwardingCollection<E>
public java.lang.Object[] toArray()
toArray
in interface java.util.Collection<E>
toArray
in class ForwardingCollection<E>
public <T> T[] toArray(T[] array)
toArray
in interface java.util.Collection<E>
toArray
in class ForwardingCollection<E>
public java.lang.String toString()
ForwardingObject
toString
method.toString
in interface Multiset<E>
toString
in class ForwardingObject