com.google.common.collect
Interface SortedMultiset<E>

All Superinterfaces:

Collection<E>, Iterable<E>, Multiset<E>

All Known Implementing Classes:

ImmutableSortedMultiset, TreeMultiset

@Beta
@GwtCompatible
public interface SortedMultiset<E>
extends Multiset<E>

A Multiset which maintains the ordering of its elements, according to either their natural order or an explicit Comparator. In all cases, this implementation uses Comparable.compareTo(T) or Comparator.compare(T, T) instead of Object.equals(java.lang.Object) 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 it is specified in terms of Object.equals(java.lang.Object).

See the Guava User Guide article on Multiset.

Since:

11.0

Author:

Louis Wasserman

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.collect.Multiset

Multiset.Entry<E>

Method Summary

Comparator<? super E>	comparator() Returns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.
SortedMultiset<E>	descendingMultiset() Returns a descending view of this multiset.
SortedSet<E>	elementSet() Returns a SortedSet view of the distinct elements 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.
Iterator<E>	iterator()
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.
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.

Methods inherited from interface com.google.common.collect.Multiset

add, add, contains, containsAll, count, entrySet, equals, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, toString

Methods inherited from interface java.util.Collection

addAll, clear, isEmpty, size, toArray, toArray

Method Detail

comparator

Comparator<? super E> comparator()

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

firstEntry

Multiset.Entry<E> firstEntry()

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

lastEntry

Multiset.Entry<E> lastEntry()

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

pollFirstEntry

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.

pollLastEntry

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.

elementSet

SortedSet<E> elementSet()

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

Specified by:

elementSet in interface Multiset<E>

Returns:

a view of the set of distinct elements in this multiset

iterator

Iterator<E> iterator()

Elements that occur multiple times in the multiset will appear multiple times in this iterator, though not necessarily sequentially.

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

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Multiset<E>

descendingMultiset

SortedMultiset<E> descendingMultiset()

Returns a descending view of this multiset. Modifications made to either map will be reflected in the other.

headMultiset

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.

subMultiset

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

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.