protected abstract class ForwardingSortedMultiset.StandardDescendingMultiset extends ForwardingMultiset<E>
A skeleton implementation of a descending multiset view. Normally, descendingMultiset() will not reflect any changes you make to the behavior of methods such as ForwardingCollection.add(Object) or pollFirstEntry(). This skeleton implementation correctly delegates each of its operations to the appropriate methods of this ForwardingSortedMultiset.
In many cases, you may wish to override descendingMultiset() to return an instance of a subclass of StandardDescendingMultiset.
ForwardingMultiset.StandardElementSetMultiset.Entry<E>| Constructor and Description |
|---|
StandardDescendingMultiset()
Constructor for use by subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
Comparator<? super E> |
comparator()
Returns the comparator that orders this multiset, or
Ordering.natural() if the natural ordering of the elements is used. |
protected Multiset<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
SortedMultiset<E> |
descendingMultiset()
Returns a descending view of this multiset.
|
NavigableSet<E> |
elementSet()
Returns the set of distinct elements contained in this multiset.
|
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. |
SortedMultiset<E> |
headMultiset(E toElement,
BoundType boundType)
Returns a view of this multiset restricted to the elements less than
upperBound, optionally including upperBound itself. |
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. |
Object[] |
toArray() |
<T> T[] |
toArray(T[] array) |
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, standardToStringadd, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArrayclone, finalize, getClass, notify, notifyAll, wait, wait, waitadd, add, contains, containsAll, count, equals, hashCode, remove, remove, removeAll, retainAll, setCount, setCountaddAll, clear, isEmpty, parallelStream, removeIf, size, spliterator, streampublic StandardDescendingMultiset()
Constructor for use by subclasses.
public Comparator<? super E> comparator()
SortedMultisetReturns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.
comparator in interface SortedMultiset<E>public NavigableSet<E> elementSet()
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().
elementSet in interface Multiset<E>elementSet in interface SortedMultiset<E>elementSet in class ForwardingMultiset<E>public Multiset.Entry<E> pollFirstEntry()
SortedMultisetReturns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.
pollFirstEntry in interface SortedMultiset<E>public Multiset.Entry<E> pollLastEntry()
SortedMultisetReturns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.
pollLastEntry in interface SortedMultiset<E>public SortedMultiset<E> headMultiset(E toElement, BoundType boundType)
SortedMultisetReturns a view of this multiset restricted to the elements less than 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)
SortedMultisetReturns a view of this multiset restricted to the range between 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)
SortedMultisetReturns a view of this multiset restricted to the elements greater than 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()
ForwardingObjectReturns 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
delegate in class ForwardingMultiset<E>public SortedMultiset<E> descendingMultiset()
SortedMultisetReturns a descending view of this multiset. Modifications made to either map will be reflected in the other.
descendingMultiset in interface SortedMultiset<E>public Multiset.Entry<E> firstEntry()
SortedMultisetReturns the entry of the first element in this multiset, or null if this multiset is empty.
firstEntry in interface SortedMultiset<E>public Multiset.Entry<E> lastEntry()
SortedMultisetReturns the entry of the last element in this multiset, or null if this multiset is empty.
lastEntry in interface SortedMultiset<E>public Set<Multiset.Entry<E>> entrySet()
MultisetReturns 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. 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>public Iterator<E> iterator()
SortedMultisetElements 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 SortedMultiset<E>iterator in interface Iterable<E>iterator in interface Collection<E>iterator in class ForwardingCollection<E>public Object[] toArray()
toArray in interface Collection<E>toArray in class ForwardingCollection<E>public <T> T[] toArray(T[] array)
toArray in interface Collection<E>toArray in class ForwardingCollection<E>public String toString()
ForwardingObjectReturns the string representation generated by the delegate’s toString method.
toString in interface Multiset<E>toString in class ForwardingObject