@Beta @GwtCompatible(emulated=true) public abstract class ForwardingSortedMultiset<E> extends ForwardingMultiset<E> implements SortedMultiset <E>
Warning: The methods of ForwardingSortedMultiset
forward indiscriminately to the methods of the delegate. For example, overriding ForwardingMultiset
alone will not change the behavior of ForwardingCollection
, which can lead to unexpected behavior. In this case, you should override add(Object)
as well, either providing your own implementation, or delegating to the provided standardAdd
method.
The standard
methods and any collection views they return are not guaranteed to be thread-safe, even when all of the methods that they depend on are thread-safe.
Modifier and Type | Class and Description |
---|---|
protected class |
ForwardingSortedMultiset
A skeleton implementation of a descending multiset view.
|
protected class |
ForwardingSortedMultiset
A sensible implementation of
SortedMultiset in terms of the following methods:
Collection ,
SortedMultiset ,
Multiset ,
Multiset ,
Multiset ,
SortedMultiset
SortedMultiset ,
Collection ,
SortedMultiset ,
SortedMultiset ,
SortedMultiset , the
size() and
iterator() methods of
SortedMultiset , and
Multiset .
|
Multiset.Entry <E>
Modifier | Constructor and Description |
---|---|
protected |
ForwardingSortedMultiset()
Constructor for use by subclasses.
|
Modifier and Type | Method and Description |
---|---|
Comparator |
comparator()
Returns the comparator that orders this multiset, or
Ordering if the natural ordering of the elements is used.
|
protected abstract SortedMultiset |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
SortedMultiset |
descendingMultiset()
Returns a descending view of this multiset.
|
NavigableSet |
elementSet()
Returns the set of distinct elements contained in this multiset.
|
Multiset |
firstEntry()
Returns the entry of the first element in this multiset, or
null if this multiset is empty.
|
SortedMultiset |
headMultiset(E upperBound, BoundType
Returns a view of this multiset restricted to the elements less than
upperBound , optionally including
upperBound itself.
|
Multiset |
lastEntry()
Returns the entry of the last element in this multiset, or
null if this multiset is empty.
|
Multiset |
pollFirstEntry()
Returns and removes the entry associated with the lowest element in this multiset, or returns
null if this multiset is empty.
|
Multiset |
pollLastEntry()
Returns and removes the entry associated with the greatest element in this multiset, or returns
null if this multiset is empty.
|
protected Multiset |
standardFirstEntry()
A sensible definition of
firstEntry() in terms of
entrySet().iterator() .
|
protected Multiset |
standardLastEntry()
A sensible definition of
lastEntry() in terms of
descendingMultiset().entrySet().iterator() .
|
protected Multiset |
standardPollFirstEntry()
A sensible definition of
pollFirstEntry() in terms of
entrySet().iterator() .
|
protected Multiset |
standardPollLastEntry()
A sensible definition of
pollLastEntry() in terms of
descendingMultiset().entrySet().iterator() .
|
protected SortedMultiset |
standardSubMultiset(E lowerBound, BoundType
A sensible definition of
subMultiset(Object, BoundType, Object, BoundType) in terms of
headMultiset and
tailMultiset .
|
SortedMultiset |
subMultiset(E lowerBound, BoundType
Returns a view of this multiset restricted to the range between
lowerBound and
upperBound .
|
SortedMultiset |
tailMultiset(E lowerBound, BoundType
Returns a view of this multiset restricted to the elements greater than
lowerBound , optionally including
lowerBound itself.
|
add, count, entrySet, 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, iterator, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray, toArray, toArray
toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
entrySet, iterator
add, add, contains, containsAll, count, equals, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, toString
addAll, clear, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray
protected ForwardingSortedMultiset()
protected abstract SortedMultiset<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.
public 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 class
ForwardingMultiset<E>
public Comparator<? super E> comparator()
SortedMultiset
Ordering.natural()
if the natural ordering of the elements is used.
public SortedMultiset<E> descendingMultiset()
SortedMultiset
public Multiset.Entry <E> firstEntry()
SortedMultiset
null
if this multiset is empty.
protected Multiset.Entry <E> standardFirstEntry()
firstEntry()
in terms of
entrySet().iterator()
. If you override
ForwardingMultiset.entrySet()
, you may wish to override
firstEntry()
to forward to this implementation.
public Multiset.Entry <E> lastEntry()
SortedMultiset
null
if this multiset is empty.
protected Multiset.Entry <E> standardLastEntry()
lastEntry()
in terms of
descendingMultiset().entrySet().iterator()
. If you override
descendingMultiset()
or
ForwardingMultiset.entrySet()
, you may wish to override
firstEntry()
to forward to this implementation.
public Multiset.Entry <E> pollFirstEntry()
SortedMultiset
null
if this multiset is empty.
protected Multiset.Entry <E> standardPollFirstEntry()
pollFirstEntry()
in terms of
entrySet().iterator()
. If you override
ForwardingMultiset.entrySet()
, you may wish to override
pollFirstEntry()
to forward to this implementation.
public Multiset.Entry <E> pollLastEntry()
SortedMultiset
null
if this multiset is empty.
protected Multiset.Entry <E> standardPollLastEntry()
pollLastEntry()
in terms of
descendingMultiset().entrySet().iterator()
. If you override
descendingMultiset()
or
ForwardingMultiset.entrySet()
, you may wish to override
pollLastEntry()
to forward to this implementation.
public SortedMultiset<E> headMultiset(E upperBound, 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.
public SortedMultiset<E> subMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
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)
.
protected SortedMultiset<E> standardSubMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
subMultiset(Object, BoundType, Object, BoundType)
in terms of
headMultiset
and
tailMultiset
. If you override either of these methods, you may wish to override
subMultiset(Object, BoundType, Object, BoundType)
to forward to this implementation.
public SortedMultiset<E> tailMultiset(E lowerBound, 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.