@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.add(Object, int) alone will not change the behavior of ForwardingCollection.add(Object),
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.StandardDescendingMultiset
A skeleton implementation of a descending multiset view.
|
protected class |
ForwardingSortedMultiset.StandardElementSet
A sensible implementation of
SortedMultiset.elementSet() in terms of the following
methods: Collection.clear(), SortedMultiset.comparator(), Multiset.contains(java.lang.Object), Multiset.containsAll(java.util.Collection<?>), Multiset.count(java.lang.Object),
SortedMultiset.firstEntry() SortedMultiset.headMultiset(E, com.google.common.collect.BoundType), Collection.isEmpty(), SortedMultiset.lastEntry(), SortedMultiset.subMultiset(E, com.google.common.collect.BoundType, E, com.google.common.collect.BoundType),
SortedMultiset.tailMultiset(E, com.google.common.collect.BoundType), the size() and iterator() methods of
SortedMultiset.entrySet(), and Multiset.remove(Object, int). |
Multiset.Entry<E>| Modifier | Constructor and Description |
|---|---|
protected |
ForwardingSortedMultiset()
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 abstract SortedMultiset<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.
|
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 upperBound,
BoundType boundType)
Returns a view of this multiset restricted to the elements less than
upperBound, optionally including upperBound itself. |
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. |
protected Multiset.Entry<E> |
standardFirstEntry()
A sensible definition of
firstEntry() in terms of entrySet().iterator(). |
protected Multiset.Entry<E> |
standardLastEntry()
A sensible definition of
lastEntry() in terms of descendingMultiset().entrySet().iterator(). |
protected Multiset.Entry<E> |
standardPollFirstEntry()
A sensible definition of
pollFirstEntry() in terms of entrySet().iterator(). |
protected Multiset.Entry<E> |
standardPollLastEntry()
A sensible definition of
pollLastEntry() in terms of descendingMultiset().entrySet().iterator(). |
protected SortedMultiset<E> |
standardSubMultiset(E lowerBound,
BoundType lowerBoundType,
E upperBound,
BoundType upperBoundType)
A sensible definition of
subMultiset(Object, BoundType, Object, BoundType) in terms
of headMultiset and
tailMultiset. |
SortedMultiset<E> |
subMultiset(E lowerBound,
BoundType lowerBoundType,
E upperBound,
BoundType upperBoundType)
Returns a view of this multiset restricted to the range between
lowerBound and upperBound. |
SortedMultiset<E> |
tailMultiset(E lowerBound,
BoundType 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, standardToStringadd, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray, toArray, toArraytoStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitentrySet, iteratorprotected ForwardingSortedMultiset()
protected abstract SortedMultiset<E> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply
the instance being decorated.delegate in class ForwardingMultiset<E>public NavigableSet<E> elementSet()
MultisetIf 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()
SortedMultisetOrdering.natural() if the natural ordering of the elements is used.comparator in interface SortedMultiset<E>public SortedMultiset<E> descendingMultiset()
SortedMultisetdescendingMultiset in interface SortedMultiset<E>public Multiset.Entry<E> firstEntry()
SortedMultisetnull if
this multiset is empty.firstEntry in interface SortedMultiset<E>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()
SortedMultisetnull if
this multiset is empty.lastEntry in interface SortedMultiset<E>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()
SortedMultisetnull if this multiset is empty.pollFirstEntry in interface SortedMultiset<E>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()
SortedMultisetnull if this multiset is empty.pollLastEntry in interface SortedMultiset<E>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)
SortedMultisetupperBound, 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 lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
SortedMultisetlowerBound 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>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)
SortedMultisetlowerBound, 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>Copyright © 2010-2014. All Rights Reserved.