Class ImmutableSortedMultiset<E>

java.lang.Object

java.util.AbstractCollection<E>

com.google.common.collect.ImmutableCollection<E>

com.google.common.collect.ImmutableMultiset<E>

com.google.common.collect.ImmutableSortedMultiset<E>

All Implemented Interfaces:

Multiset<E>, SortedMultiset<E>, Serializable, Iterable<E>, Collection<E>

@GwtIncompatible
public abstract class ImmutableSortedMultiset<E>
extends ImmutableMultiset<E>
implements SortedMultiset<E>

A SortedMultiset whose contents will never change, with many other important properties detailed at ImmutableCollection.

Warning: as with any sorted collection, you are strongly advised not to use a Comparator or Comparable type whose comparison behavior is inconsistent with equals. That is, a.compareTo(b) or comparator.compare(a, b) should equal zero if and only if a.equals(b). If this advice is not followed, the resulting collection will not correctly obey its specification.

See the Guava User Guide article on immutable collections.

Since:

12.0

Author:

Louis Wasserman

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableSortedMultiset.Builder<E>	A builder for creating immutable multiset instances, especially public static final multisets ("constant multisets").

Nested classes/interfaces inherited from interface Multiset

Multiset.Entry<E>

Method Summary

Modifier and Type	Method	Description
static <E> ImmutableSortedMultiset.Builder<E>	builder()	Deprecated. Use naturalOrder(), which offers better type-safety.
final Comparator<? super E>	comparator()	Returns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	copyOf(E[] elements)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	copyOf(Iterable<? extends E> elements)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	copyOf(Comparator<? super E> comparator, Iterable<? extends E> elements)	Returns an immutable sorted multiset containing the given elements sorted by the given Comparator.
static <E> ImmutableSortedMultiset<E>	copyOf(Comparator<? super E> comparator, Iterator<? extends E> elements)	Returns an immutable sorted multiset containing the given elements sorted by the given Comparator.
static <E> ImmutableSortedMultiset<E>	copyOf(Iterator<? extends E> elements)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <Z> ImmutableSortedMultiset<Z>	copyOf(Z[] elements)	Deprecated. Pass parameters of type Comparable to use copyOf(Comparable[]).
static <E> ImmutableSortedMultiset<E>	copyOfSorted(SortedMultiset<E> sortedMultiset)	Returns an immutable sorted multiset containing the elements of a sorted multiset, sorted by the same Comparator.
ImmutableSortedMultiset<E>	descendingMultiset()	Returns a descending view of this multiset.
abstract ImmutableSortedSet<E>	elementSet()	Returns the set of distinct elements contained in this multiset.
abstract ImmutableSortedMultiset<E>	headMultiset(E upperBound, BoundType boundType)	Returns a view of this multiset restricted to the elements less than upperBound, optionally including upperBound itself.
static <E extends Comparable<?>> ImmutableSortedMultiset.Builder<E>	naturalOrder()	Returns a builder that creates immutable sorted multisets whose elements are ordered by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of()	Returns the empty immutable sorted multiset.
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1)	Returns an immutable sorted multiset containing a single element.
static <E> ImmutableSortedMultiset<E>	of(E e1)	Deprecated. Pass a parameter of type Comparable to use of(Comparable).
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1, E e2)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of(E e1, E e2)	Deprecated. Pass the parameters of type Comparable to use of(Comparable, Comparable).
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3)	Deprecated. Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable).
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4)	Deprecated. Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable).
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4, E e5)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4, E e5)	Deprecated. Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable, Comparable) .
static <E extends Comparable<? super E>> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4, E e5, E e6, E... remaining)	Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedMultiset<E>	of(E e1, E e2, E e3, E e4, E e5, E e6, E... remaining)	Deprecated. Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable, Comparable, Comparable, Comparable...) .
static <E> ImmutableSortedMultiset.Builder<E>	orderedBy(Comparator<E> comparator)	Returns a builder that creates immutable sorted multisets with an explicit comparator.
final @Nullable Multiset.Entry<E>	pollFirstEntry()	Deprecated. Unsupported operation.
final @Nullable Multiset.Entry<E>	pollLastEntry()	Deprecated. Unsupported operation.
static <E extends Comparable<?>> ImmutableSortedMultiset.Builder<E>	reverseOrder()	Returns a builder that creates immutable sorted multisets whose elements are ordered by the reverse of their natural ordering.
ImmutableSortedMultiset<E>	subMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)	Returns a view of this multiset restricted to the range between lowerBound and upperBound.
abstract ImmutableSortedMultiset<E>	tailMultiset(E lowerBound, BoundType boundType)	Returns a view of this multiset restricted to the elements greater than lowerBound, optionally including lowerBound itself.
static <E> Collector<E, ?, ImmutableMultiset<E>>	toImmutableMultiset()	Deprecated. Use toImmutableSortedMultiset(Comparator).
static <T extends @Nullable Object, E> Collector<T, ?, ImmutableMultiset<E>>	toImmutableMultiset(Function<? super T, ? extends E> elementFunction, ToIntFunction<? super T> countFunction)	Deprecated. Use toImmutableSortedMultiset(Comparator).
static <E> Collector<E, ?, ImmutableSortedMultiset<E>>	toImmutableSortedMultiset(Comparator<? super E> comparator)	Returns a Collector that accumulates the input elements into a new ImmutableMultiset.
static <T extends @Nullable Object, E> Collector<T, ?, ImmutableSortedMultiset<E>>	toImmutableSortedMultiset(Comparator<? super E> comparator, Function<? super T, ? extends E> elementFunction, ToIntFunction<? super T> countFunction)	Returns a Collector that accumulates elements into an ImmutableSortedMultiset whose elements are the result of applying elementFunction to the inputs, with counts equal to the result of applying countFunction to the inputs.

Methods inherited from class ImmutableMultiset

add, asList, contains, entrySet, equals, hashCode, iterator, remove, setCount, setCount, toString

Methods inherited from class ImmutableCollection

add, addAll, clear, remove, removeAll, removeIf, retainAll, spliterator, toArray, toArray

Methods inherited from class AbstractCollection

containsAll, isEmpty, size

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

addAll, clear, isEmpty, parallelStream, removeIf, stream, toArray, toArray, toArray

Methods inherited from interface Multiset

add, add, contains, containsAll, count, equals, forEach, forEachEntry, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, size, spliterator, toString

Methods inherited from interface SortedMultiset

entrySet, firstEntry, iterator, lastEntry

Method Details

toImmutableSortedMultiset

public static <E>
Collector<E, ?, ImmutableSortedMultiset<E>> toImmutableSortedMultiset(Comparator<? super E> comparator)

Returns a Collector that accumulates the input elements into a new ImmutableMultiset. Elements are sorted by the specified comparator.

Warning: comparator should be consistent with equals as explained in the Comparator documentation.

Since:

21.0

toImmutableSortedMultiset

public static <T extends @Nullable Object, E>
Collector<T, ?, ImmutableSortedMultiset<E>> toImmutableSortedMultiset(Comparator<? super E> comparator,
 Function<? super T, ? extends E> elementFunction,
 ToIntFunction<? super T> countFunction)

Returns a Collector that accumulates elements into an ImmutableSortedMultiset whose elements are the result of applying elementFunction to the inputs, with counts equal to the result of applying countFunction to the inputs.

If the mapped elements contain duplicates (according to comparator), the first occurrence in encounter order appears in the resulting multiset, with count equal to the sum of the outputs of countFunction.applyAsInt(t) for each t mapped to that element.

Since:

22.0

of

public static <E> ImmutableSortedMultiset<E> of()

Returns the empty immutable sorted multiset.

Performance note: the instance returned is a singleton.

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1)

Returns an immutable sorted multiset containing a single element.

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1,
 E e2)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any element is null

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any element is null

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any element is null

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4,
 E e5)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any element is null

of

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4,
 E e5,
 E e6,
 E... remaining)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any element is null

copyOf

public static <E extends Comparable<? super E>>
ImmutableSortedMultiset<E> copyOf(E[] elements)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

Throws:

NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableSortedMultiset<E> copyOf(Iterable<? extends E> elements)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering. To create a copy of a SortedMultiset that preserves the comparator, call copyOfSorted(SortedMultiset) instead. This method iterates over elements at most once.

Note that if s is a Multiset<String>, then ImmutableSortedMultiset.copyOf(s) returns an ImmutableSortedMultiset<String> containing each of the strings in s, while ImmutableSortedMultiset.of(s) returns an ImmutableSortedMultiset<Multiset<String>> containing one element (the given multiset itself).

Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

This method is not type-safe, as it may be called on elements that are not mutually comparable.

Throws:

ClassCastException - if the elements are not mutually comparable

NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableSortedMultiset<E> copyOf(Iterator<? extends E> elements)

Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.

This method is not type-safe, as it may be called on elements that are not mutually comparable.

Throws:

ClassCastException - if the elements are not mutually comparable

NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableSortedMultiset<E> copyOf(Comparator<? super E> comparator,
 Iterator<? extends E> elements)

Returns an immutable sorted multiset containing the given elements sorted by the given Comparator.

Throws:

NullPointerException - if comparator or any of elements is null

copyOf

public static <E> ImmutableSortedMultiset<E> copyOf(Comparator<? super E> comparator,
 Iterable<? extends E> elements)

Returns an immutable sorted multiset containing the given elements sorted by the given Comparator. This method iterates over elements at most once.

Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

Throws:

NullPointerException - if comparator or any of elements is null

copyOfSorted

public static <E> ImmutableSortedMultiset<E> copyOfSorted(SortedMultiset<E> sortedMultiset)

Returns an immutable sorted multiset containing the elements of a sorted multiset, sorted by the same Comparator. That behavior differs from copyOf(Iterable), which always uses the natural ordering of the elements.

Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

This method is safe to use even when sortedMultiset is a synchronized or concurrent collection that is currently being modified by another thread.

Throws:

NullPointerException - if sortedMultiset or any of its elements is null

comparator

public final Comparator<? super E> comparator()

Description copied from interface: SortedMultiset

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

Specified by:

comparator in interface SortedMultiset<E>

elementSet

public abstract ImmutableSortedSet<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 interface Multiset<E>

Specified by:

elementSet in interface SortedMultiset<E>

Specified by:

elementSet in class ImmutableMultiset<E>

Returns:

a view of the set of distinct elements in this multiset

descendingMultiset

public ImmutableSortedMultiset<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 interface SortedMultiset<E>

pollFirstEntry

@CanIgnoreReturnValue
@Deprecated
public final @Nullable Multiset.Entry<E> pollFirstEntry()

Deprecated.

Unsupported operation.

Returns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.

This implementation is guaranteed to throw an UnsupportedOperationException.

Specified by:

pollFirstEntry in interface SortedMultiset<E>

Throws:

UnsupportedOperationException - always

pollLastEntry

@CanIgnoreReturnValue
@Deprecated
public final @Nullable Multiset.Entry<E> pollLastEntry()

Deprecated.

Unsupported operation.

Returns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.

This implementation is guaranteed to throw an UnsupportedOperationException.

Specified by:

pollLastEntry in interface SortedMultiset<E>

Throws:

UnsupportedOperationException - always

headMultiset

public abstract ImmutableSortedMultiset<E> headMultiset(E upperBound,
 BoundType boundType)

Description copied from interface: SortedMultiset

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.

Specified by:

headMultiset in interface SortedMultiset<E>

subMultiset

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

Specified by:

subMultiset in interface SortedMultiset<E>

tailMultiset

public abstract ImmutableSortedMultiset<E> tailMultiset(E lowerBound,
 BoundType boundType)

Description copied from interface: SortedMultiset

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.

Specified by:

tailMultiset in interface SortedMultiset<E>

orderedBy

public static <E>
ImmutableSortedMultiset.Builder<E> orderedBy(Comparator<E> comparator)

Returns a builder that creates immutable sorted multisets with an explicit comparator. If the comparator has a more general type than the set being generated, such as creating a SortedMultiset<Integer> with a Comparator<Number>, use the ImmutableSortedMultiset.Builder constructor instead.

Throws:

NullPointerException - if comparator is null

reverseOrder

public static <E extends Comparable<?>>
ImmutableSortedMultiset.Builder<E> reverseOrder()

Returns a builder that creates immutable sorted multisets whose elements are ordered by the reverse of their natural ordering.

Note: the type parameter E extends Comparable<?> rather than Comparable<? super E> in order to accommodate users of obsolete javac versions affected by JDK-6468354.

naturalOrder

public static <E extends Comparable<?>>
ImmutableSortedMultiset.Builder<E> naturalOrder()

Returns a builder that creates immutable sorted multisets whose elements are ordered by their natural ordering. The sorted multisets use Ordering.natural() as the comparator. This method provides more type-safety than builder(), as it can be called only for classes that implement Comparable.

Note: the type parameter E extends Comparable<?> rather than Comparable<? super E> in order to accommodate users of obsolete javac versions affected by JDK-6468354.

toImmutableMultiset

@Deprecated
public static <E>
Collector<E, ?, ImmutableMultiset<E>> toImmutableMultiset()

Deprecated.

Use toImmutableSortedMultiset(Comparator).

Not supported. Use toImmutableSortedMultiset(Comparator) instead. This method exists only to hide ImmutableMultiset.toImmutableMultiset() from consumers of ImmutableSortedMultiset.

Throws:

UnsupportedOperationException - always

Since:

21.0

toImmutableMultiset

@Deprecated
public static <T extends @Nullable Object, E>
Collector<T, ?, ImmutableMultiset<E>> toImmutableMultiset(Function<? super T, ? extends E> elementFunction,
 ToIntFunction<? super T> countFunction)

Deprecated.

Use toImmutableSortedMultiset(Comparator).

Not supported. Use toImmutableSortedMultiset(Comparator) instead. This method exists only to hide ImmutableMultiset.toImmutableMultiset() from consumers of ImmutableSortedMultiset.

Throws:

UnsupportedOperationException - always

Since:

22.0

builder

@Deprecated
public static <E>
ImmutableSortedMultiset.Builder<E> builder()

Deprecated.

Use naturalOrder(), which offers better type-safety.

Not supported. Use naturalOrder(), which offers better type-safety, instead. This method exists only to hide ImmutableMultiset.builder() from consumers of ImmutableSortedMultiset.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1)

Deprecated.

Pass a parameter of type Comparable to use of(Comparable).

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1,
 E e2)

Deprecated.

Pass the parameters of type Comparable to use of(Comparable, Comparable).

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3)

Deprecated.

Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable).

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4)

Deprecated.

Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable).

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4,
 E e5)

Deprecated.

Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable, Comparable) .

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

of

@Deprecated
public static <E> ImmutableSortedMultiset<E> of(E e1,
 E e2,
 E e3,
 E e4,
 E e5,
 E e6,
 E... remaining)

Deprecated.

Pass the parameters of type Comparable to use of(Comparable, Comparable, Comparable, Comparable, Comparable, Comparable, Comparable...) .

Not supported. You are attempting to create a multiset that may contain a non- Comparable element. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always

copyOf

@Deprecated
public static <Z> ImmutableSortedMultiset<Z> copyOf(Z[] elements)

Deprecated.

Pass parameters of type Comparable to use copyOf(Comparable[]).

Not supported. You are attempting to create a multiset that may contain non- Comparable elements. Proper calls will resolve to the version in ImmutableSortedMultiset, not this dummy version.

Throws:

UnsupportedOperationException - always