Class ForwardingSortedMultiset.StandardDescendingMultiset
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingCollection<E>
-
- com.google.common.collect.ForwardingMultiset<E>
-
- com.google.common.collect.ForwardingSortedMultiset.StandardDescendingMultiset
-
- All Implemented Interfaces:
Multiset<E>
,SortedMultiset<E>
,Iterable<E>
,Collection<E>
- Enclosing class:
- ForwardingSortedMultiset<E extends @Nullable Object>
protected abstract class ForwardingSortedMultiset.StandardDescendingMultiset extends ForwardingMultiset<E>
A skeleton implementation of a descending multiset view. Normally,SortedMultiset.descendingMultiset()
will not reflect any changes you make to the behavior of methods such asForwardingCollection.add(Object)
orSortedMultiset.pollFirstEntry()
. This skeleton implementation correctly delegates each of its operations to the appropriate methods of thisForwardingSortedMultiset
.In many cases, you may wish to override
SortedMultiset.descendingMultiset()
to return an instance of a subclass ofStandardDescendingMultiset
.- Since:
- 15.0
-
-
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 extends @Nullable Object>
-
-
Constructor Summary
Constructors Constructor Description StandardDescendingMultiset()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Comparator<? super E>
comparator()
Returns the comparator that orders this multiset, orOrdering.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 intoMultiset.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, ornull
if this multiset is empty.SortedMultiset<E>
headMultiset(E toElement, BoundType boundType)
Returns a view of this multiset restricted to the elements less thanupperBound
, optionally includingupperBound
itself.Iterator<E>
iterator()
Returns an iterator over the elements in this collection.Multiset.Entry<E>
lastEntry()
Returns the entry of the last element in this multiset, ornull
if this multiset is empty.Multiset.Entry<E>
pollFirstEntry()
Returns and removes the entry associated with the lowest element in this multiset, or returnsnull
if this multiset is empty.Multiset.Entry<E>
pollLastEntry()
Returns and removes the entry associated with the greatest element in this multiset, or returnsnull
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 betweenlowerBound
andupperBound
.SortedMultiset<E>
tailMultiset(E fromElement, BoundType boundType)
Returns a view of this multiset restricted to the elements greater thanlowerBound
, optionally includinglowerBound
itself.@Nullable Object[]
toArray()
Returns an array containing all of the elements in this collection.<T extends @Nullable Object>
T[]toArray(T[] array)
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.String
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, spliterator, stream, toArray
-
-
-
-
Constructor Detail
-
StandardDescendingMultiset
public StandardDescendingMultiset()
Constructor for use by subclasses.
-
-
Method Detail
-
comparator
public Comparator<? super E> 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 interfaceSortedMultiset<E extends @Nullable Object>
-
elementSet
public NavigableSet<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 extends @Nullable Object>
- Specified by:
elementSet
in interfaceSortedMultiset<E extends @Nullable Object>
- Overrides:
elementSet
in classForwardingMultiset<E extends @Nullable Object>
- Returns:
- a view of the set of distinct elements in this multiset
-
pollFirstEntry
@CheckForNull public Multiset.Entry<E> 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 extends @Nullable Object>
-
pollLastEntry
@CheckForNull public Multiset.Entry<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 extends @Nullable Object>
-
headMultiset
public SortedMultiset<E> headMultiset(E toElement, BoundType boundType)
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 extends @Nullable Object>
-
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 extends @Nullable Object>
-
tailMultiset
public SortedMultiset<E> tailMultiset(E fromElement, BoundType boundType)
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 extends @Nullable Object>
-
delegate
protected Multiset<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 extends @Nullable Object>
-
descendingMultiset
public SortedMultiset<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 extends @Nullable Object>
-
firstEntry
@CheckForNull public Multiset.Entry<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 extends @Nullable Object>
-
lastEntry
@CheckForNull public Multiset.Entry<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 extends @Nullable Object>
-
entrySet
public Set<Multiset.Entry<E>> 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.
-
iterator
public Iterator<E> iterator()
Description copied from interface:java.util.Collection
Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).- Specified by:
iterator
in interfaceCollection<E extends @Nullable Object>
- Specified by:
iterator
in interfaceIterable<E extends @Nullable Object>
- Specified by:
iterator
in interfaceMultiset<E extends @Nullable Object>
- Specified by:
iterator
in interfaceSortedMultiset<E extends @Nullable Object>
- Overrides:
iterator
in classForwardingCollection<E extends @Nullable Object>
- Returns:
- an
Iterator
over the elements in this collection
-
toArray
public @Nullable Object[] toArray()
Description copied from interface:java.util.Collection
Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type isObject
.The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
- Specified by:
toArray
in interfaceCollection<E extends @Nullable Object>
- Overrides:
toArray
in classForwardingCollection<E extends @Nullable Object>
- Returns:
- an array, whose runtime component
type is
Object
, containing all of the elements in this collection
-
toArray
public <T extends @Nullable Object> T[] toArray(T[] array)
Description copied from interface:java.util.Collection
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to
null
. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain anynull
elements.)If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
- Specified by:
toArray
in interfaceCollection<E extends @Nullable Object>
- Overrides:
toArray
in classForwardingCollection<E extends @Nullable Object>
- Type Parameters:
T
- the component type of the array to contain the collection- Parameters:
array
- the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.- Returns:
- an array containing all of the elements in this collection
-
toString
public String toString()
Description copied from class:ForwardingObject
Returns the string representation generated by the delegate'stoString
method.
-
-