Class UnmodifiableSortedMultiset<E>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingCollection<E>
-
- com.google.common.collect.ForwardingMultiset<E>
-
- com.google.common.collect.Multisets.UnmodifiableMultiset<E>
-
- com.google.common.collect.UnmodifiableSortedMultiset<E>
-
- All Implemented Interfaces:
Multiset<E>
,SortedIterable<E>
,SortedMultiset<E>
,SortedMultisetBridge<E>
,java.io.Serializable
,java.lang.Iterable<E>
,java.util.Collection<E>
final class UnmodifiableSortedMultiset<E> extends Multisets.UnmodifiableMultiset<E> implements SortedMultiset<E>
Implementation ofMultisets.unmodifiableSortedMultiset(SortedMultiset)
, split out into its own file so it can be GWT emulated (to deal with the differing elementSet() types in GWT and non-GWT).
-
-
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>
-
-
Field Summary
Fields Modifier and Type Field Description private UnmodifiableSortedMultiset<E>
descendingMultiset
private static long
serialVersionUID
-
Fields inherited from class com.google.common.collect.Multisets.UnmodifiableMultiset
delegate, elementSet, entrySet
-
-
Constructor Summary
Constructors Constructor Description UnmodifiableSortedMultiset(SortedMultiset<E> delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Comparator<? super E>
comparator()
Returns the comparator that orders this multiset, orOrdering.natural()
if the natural ordering of the elements is used.(package private) java.util.NavigableSet<E>
createElementSet()
protected SortedMultiset<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.Multiset.Entry<E>
firstEntry()
Returns the entry of the first element in this multiset, ornull
if this multiset is empty.SortedMultiset<E>
headMultiset(E upperBound, BoundType boundType)
Returns a view of this multiset restricted to the elements less thanupperBound
, optionally includingupperBound
itself.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 lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
Returns a view of this multiset restricted to the range betweenlowerBound
andupperBound
.SortedMultiset<E>
tailMultiset(E lowerBound, BoundType boundType)
Returns a view of this multiset restricted to the elements greater thanlowerBound
, optionally includinglowerBound
itself.-
Methods inherited from class com.google.common.collect.Multisets.UnmodifiableMultiset
add, add, addAll, clear, entrySet, iterator, remove, remove, removeAll, retainAll, setCount, setCount
-
Methods inherited from class com.google.common.collect.ForwardingMultiset
count, equals, hashCode, standardAdd, standardAddAll, standardClear, standardContains, standardCount, standardEquals, standardHashCode, standardIterator, standardRemove, standardRemoveAll, standardRetainAll, standardSetCount, standardSetCount, standardSize, standardToString
-
Methods inherited from class com.google.common.collect.ForwardingCollection
contains, containsAll, isEmpty, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray, toArray, toArray
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
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, stream, toArray, toArray, toArray
-
Methods inherited from interface com.google.common.collect.Multiset
add, add, contains, containsAll, count, equals, forEach, forEachEntry, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, size, spliterator, toString
-
Methods inherited from interface com.google.common.collect.SortedMultiset
entrySet, iterator
-
-
-
-
Field Detail
-
descendingMultiset
@CheckForNull private transient UnmodifiableSortedMultiset<E> descendingMultiset
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UnmodifiableSortedMultiset
UnmodifiableSortedMultiset(SortedMultiset<E> delegate)
-
-
Method Detail
-
delegate
protected SortedMultiset<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.- Overrides:
delegate
in classMultisets.UnmodifiableMultiset<E>
-
comparator
public java.util.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 interfaceSortedIterable<E>
- Specified by:
comparator
in interfaceSortedMultiset<E>
-
createElementSet
java.util.NavigableSet<E> createElementSet()
- Overrides:
createElementSet
in classMultisets.UnmodifiableMultiset<E>
-
elementSet
public java.util.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>
- Specified by:
elementSet
in interfaceSortedMultiset<E>
- Specified by:
elementSet
in interfaceSortedMultisetBridge<E>
- Overrides:
elementSet
in classMultisets.UnmodifiableMultiset<E>
- Returns:
- a view of the set of distinct elements in this multiset
-
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>
-
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>
-
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>
-
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>
-
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>
-
headMultiset
public SortedMultiset<E> headMultiset(E upperBound, 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>
-
subMultiset
public SortedMultiset<E> subMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
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>
-
tailMultiset
public SortedMultiset<E> tailMultiset(E lowerBound, 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>
-
-