Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.collect.SortedMultiset

A Multiset which maintains the ordering of its elements, according to either their natural order or an explicit Comparator. This order is reflected when iterating over the sorted multiset, either directly, or through its elementSet or entrySet views. In all cases, this implementation uses Comparable#compareTo or Comparator#compare instead of Object#equals to determine equivalence of instances.

Warning

The comparison must be consistent with equals as explained by the Comparable class specification. Otherwise, the resulting multiset will violate the Collection contract, which is specified in terms of Object#equals.

See the Guava User Guide article on Multiset.

Method Summary

Modifier and Type	Method and Description
public Comparator<? super E>	comparator() Redeclares com.google.common.collect.SortedIterable.comparator. Returns the comparator that orders this multiset, or `Ordering#natural()` if the natural ordering of the elements is used.
public SortedMultiset<E>	descendingMultiset() Returns a descending view of this multiset.
public NavigableSet<E>	elementSet() Redeclares com.google.common.collect.SortedMultisetBridge.elementSet. Returns a `NavigableSet` view of the distinct elements in this multiset.
public Set<Multiset.Entry<E>>	entrySet() Redeclares com.google.common.collect.Multiset.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.
public Multiset.Entry<E>	firstEntry() Returns the entry of the first element in this multiset, or `null` if this multiset is empty.
public SortedMultiset<E>	headMultiset(E upperBound, BoundType boundType) Returns a view of this multiset restricted to the elements less than `upperBound`, optionally including `upperBound` itself.
public Iterator<E>	iterator() Redeclares com.google.common.collect.Multiset.iterator, com.google.common.collect.SortedIterable.iterator. Returns an iterator over elements of type `T`.
public Multiset.Entry<E>	lastEntry() Returns the entry of the last element in this multiset, or `null` if this multiset is empty.
public 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.
public 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.
public 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`.
public SortedMultiset<E>	tailMultiset(E lowerBound, BoundType boundType) Returns a view of this multiset restricted to the elements greater than `lowerBound`, optionally including `lowerBound` itself.

Method Detail

comparator back to summary

comparator	back to summary
public Comparator<? super E> comparator() Redeclares com.google.common.collect.SortedIterable.comparator. Returns the comparator that orders this multiset, or `Ordering#natural()` if the natural ordering of the elements is used. Annotations @Override

public Comparator<? super E> comparator()

Redeclares com.google.common.collect.SortedIterable.comparator.

Returns the comparator that orders this multiset, or Ordering#natural() if the natural ordering of the elements is used.

Annotations

@Override

descendingMultiset	back to summary
public SortedMultiset<E> descendingMultiset() Returns a descending view of this multiset. Modifications made to either map will be reflected in the other.

elementSet back to summary

elementSet	back to summary
public NavigableSet<E> elementSet() Redeclares com.google.common.collect.SortedMultisetBridge.elementSet. Returns a `NavigableSet` view of the distinct elements in this multiset. Returns:NavigableSet<E> Doc from com.google.common.collect.Multiset.elementSet. a view of the set of distinct elements in this multiset Annotations @Override Since 14.0 (present with return type `SortedSet` since 11.0)

public NavigableSet<E> elementSet()

Redeclares com.google.common.collect.SortedMultisetBridge.elementSet.

Returns a NavigableSet view of the distinct elements in this multiset.

Returns:NavigableSet<E>

Doc from com.google.common.collect.Multiset.elementSet.

a view of the set of distinct elements in this multiset

Annotations

@Override

Since

14.0 (present with return type SortedSet since 11.0)

entrySet back to summary

entrySet	back to summary
public Set<Multiset.Entry<E>> entrySet() Redeclares com.google.common.collect.Multiset.entrySet. Doc from com.google.common.collect.Multiset.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. This set contains exactly one entry for each distinct element in the multiset (thus it always has the same size as the `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. The `entrySet`'s iterator returns entries in ascending element order according to this multiset's comparator. Returns:Set<Multiset.Entry<E>> a set of entries representing the data of this multiset Annotations @Override

public Set<Multiset.Entry<E>> entrySet()

Redeclares com.google.common.collect.Multiset.entrySet.

Doc from com.google.common.collect.Multiset.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. This set contains exactly one entry for each distinct element in the multiset (thus it always has the same size as the 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.

The entrySet's iterator returns entries in ascending element order according to this multiset's comparator.

Returns:Set<Multiset.Entry<E>>

a set of entries representing the data of this multiset

Annotations

@Override

firstEntry back to summary

firstEntry	back to summary
public Multiset.Entry<E> firstEntry() Returns the entry of the first element in this multiset, or `null` if this multiset is empty. Annotations @CheckForNull

public Multiset.Entry<E> firstEntry()

Returns the entry of the first element in this multiset, or null if this multiset is empty.

Annotations

@CheckForNull

headMultiset back to summary

headMultiset	back to summary
public SortedMultiset<E> headMultiset(E upperBound, BoundType boundType) Returns 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.

public SortedMultiset<E> headMultiset(E upperBound, BoundType boundType)

Returns 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.

iterator back to summary

iterator	back to summary
public Iterator<E> iterator() Redeclares com.google.common.collect.Multiset.iterator, com.google.common.collect.SortedIterable.iterator. Doc from com.google.common.collect.SortedIterable.iterator. Returns an iterator over elements of type `T`. The elements are returned in nondecreasing order according to the associated `comparator`. The iterator returns the elements in ascending order according to this multiset's comparator. Returns:Iterator<E> Doc from java.util.Collection.iterator. an `Iterator` over the elements in this collection Annotations @Override

public Iterator<E> iterator()

Redeclares com.google.common.collect.Multiset.iterator, com.google.common.collect.SortedIterable.iterator.

Doc from com.google.common.collect.SortedIterable.iterator.

Returns an iterator over elements of type T. The elements are returned in nondecreasing order according to the associated comparator.

The iterator returns the elements in ascending order according to this multiset's comparator.

Returns:Iterator<E>

Doc from java.util.Collection.iterator.

an Iterator over the elements in this collection

Annotations

@Override

lastEntry back to summary

lastEntry	back to summary
public Multiset.Entry<E> lastEntry() Returns the entry of the last element in this multiset, or `null` if this multiset is empty. Annotations @CheckForNull

public Multiset.Entry<E> lastEntry()

Returns the entry of the last element in this multiset, or null if this multiset is empty.

Annotations

@CheckForNull

pollFirstEntry back to summary

pollFirstEntry	back to summary
public 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. Annotations @CheckForNull

public 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.

Annotations

@CheckForNull

pollLastEntry back to summary

pollLastEntry	back to summary
public 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. Annotations @CheckForNull

public 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.

Annotations

@CheckForNull

subMultiset back to summary

subMultiset	back to summary
public 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`. 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)`.

public 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. 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).

tailMultiset back to summary

tailMultiset	back to summary
public SortedMultiset<E> tailMultiset(E lowerBound, BoundType boundType) Returns 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.

public SortedMultiset<E> tailMultiset(E lowerBound, BoundType boundType)

Returns 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.

public Interface SortedMultiset<E extends @Nullable Object>

Method Summary

Method Detail