@Beta @GwtIncompatible(value="hasn\'t been tested yet") public abstract class ImmutableSortedMultiset<E> extends ImmutableMultiset<E> implements SortedMultiset <E>
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.
Modifier and Type | Class and Description |
---|---|
static class |
ImmutableSortedMultiset
A builder for creating immutable multiset instances, especially
public static final multisets ("constant multisets").
|
Multiset.Entry <E>
Modifier and Type | Method and Description |
---|---|
static <E> ImmutableSortedMultiset |
builder()
Deprecated.
Use
naturalOrder() , which offers better type-safety.
|
Comparator |
comparator()
Returns the comparator that orders this multiset, or
Ordering if the natural ordering of the elements is used.
|
static <E> ImmutableSortedMultiset |
copyOf(Comparator
Returns an immutable sorted multiset containing the given elements sorted by the given
Comparator .
|
static <E> ImmutableSortedMultiset |
copyOf(Comparator
Returns an immutable sorted multiset containing the given elements sorted by the given
Comparator .
|
static <E extends Comparable |
copyOf(E[] elements)
Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
|
static <E> ImmutableSortedMultiset |
copyOf(Iterable
Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
|
static <E> ImmutableSortedMultiset |
copyOf(Iterator
Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
|
static <E> ImmutableSortedMultiset |
copyOfSorted(SortedMultiset
Returns an immutable sorted multiset containing the elements of a sorted multiset, sorted by the same
Comparator .
|
ImmutableSortedMultiset |
descendingMultiset()
Returns a descending view of this multiset.
|
abstract ImmutableSortedSet |
elementSet()
Returns a
NavigableSet view of the distinct elements in this multiset.
|
abstract ImmutableSortedMultiset |
headMultiset(E upperBound, BoundType
Returns a view of this multiset restricted to the elements less than
upperBound , optionally including
upperBound itself.
|
static <E extends Comparable |
naturalOrder()
Returns a builder that creates immutable sorted multisets whose elements are ordered by their natural ordering.
|
static <E> ImmutableSortedMultiset |
of()
Returns the empty immutable sorted multiset.
|
static <E extends Comparable |
of(E element)
Returns an immutable sorted multiset containing a single element.
|
static <E extends Comparable |
of(E e1, E e2)
Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
|
static <E extends Comparable |
of(E e1, E e2, E e3)
Returns an immutable sorted multiset containing the given elements sorted by their natural ordering.
|
static <E extends Comparable |
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 extends Comparable |
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 extends Comparable |
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 |
orderedBy(Comparator
Returns a builder that creates immutable sorted multisets with an explicit comparator.
|
Multiset |
pollFirstEntry()
Deprecated.
Unsupported operation.
|
Multiset |
pollLastEntry()
Deprecated.
Unsupported operation.
|
static <E extends Comparable |
reverseOrder()
Returns a builder that creates immutable sorted multisets whose elements are ordered by the reverse of their natural ordering.
|
ImmutableSortedMultiset |
subMultiset(E lowerBound, BoundType
Returns a view of this multiset restricted to the range between
lowerBound and
upperBound .
|
abstract ImmutableSortedMultiset |
tailMultiset(E lowerBound, BoundType
Returns a view of this multiset restricted to the elements greater than
lowerBound , optionally including
lowerBound itself.
|
add, contains, entrySet, equals, hashCode, iterator, remove, setCount, setCount, toString
add, addAll, asList, clear, remove, removeAll, retainAll, toArray, toArray
containsAll, isEmpty, size
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
entrySet, firstEntry, iterator, lastEntry
add, add, contains, containsAll, count, equals, hashCode, remove, remove, removeAll, retainAll, setCount, setCount, toString
addAll, clear, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray
public static <E> ImmutableSortedMultiset<E> of()
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E element)
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E e1, E e2)
NullPointerException
- if any element is null
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E e1, E e2, E e3)
NullPointerException
- if any element is null
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E e1, E e2, E e3, E e4)
NullPointerException
- if any element is null
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E e1, E e2, E e3, E e4, E e5)
NullPointerException
- if any element is null
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> of(E e1, E e2, E e3, E e4, E e5, E e6, E... remaining)
NullPointerException
- if any element is null
public static <E extends Comparable<? super E>> ImmutableSortedMultiset <E> copyOf(E[] elements)
NullPointerException
- if any of
elements
is null
public static <E> ImmutableSortedMultiset<E> copyOf(Iterable <? extends E> elements)
SortedMultiset
that preserves the comparator, call
copyOfSorted(com.google.common.collect.SortedMultiset<E>)
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.
ClassCastException
- if the elements are not mutually comparable
NullPointerException
- if any of
elements
is null
public static <E> ImmutableSortedMultiset<E> copyOf(Iterator <? extends E> elements)
This method is not type-safe, as it may be called on elements that are not mutually comparable.
ClassCastException
- if the elements are not mutually comparable
NullPointerException
- if any of
elements
is null
public static <E> ImmutableSortedMultiset<E> copyOf(Comparator <? super E> comparator, Iterator <? extends E> elements)
Comparator
.
NullPointerException
- if
comparator
or any of
elements
is null
public static <E> ImmutableSortedMultiset<E> copyOf(Comparator <? super E> comparator, Iterable <? extends E> elements)
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.
NullPointerException
- if
comparator
or any of
elements
is null
public static <E> ImmutableSortedMultiset<E> copyOfSorted(SortedMultiset <E> sortedMultiset)
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.
NullPointerException
- if
sortedMultiset
or any of its elements is null
public final Comparator<? super E> comparator()
SortedMultiset
Ordering.natural()
if the natural ordering of the elements is used.
public abstract ImmutableSortedSet<E> elementSet()
SortedMultiset
NavigableSet
view of the distinct elements in this multiset.
elementSet
in interface
Multiset<E>
elementSet
in interface
SortedMultiset<E>
public ImmutableSortedMultiset<E> descendingMultiset()
SortedMultiset
@Deprecated public final Multiset.Entry <E> pollFirstEntry()
null
if this multiset is empty.
This implementation is guaranteed to throw an UnsupportedOperationException
.
pollFirstEntry
in interface
SortedMultiset<E>
UnsupportedOperationException
- always
@Deprecated public final Multiset.Entry <E> pollLastEntry()
null
if this multiset is empty.
This implementation is guaranteed to throw an UnsupportedOperationException
.
pollLastEntry
in interface
SortedMultiset<E>
UnsupportedOperationException
- always
public abstract ImmutableSortedMultiset<E> headMultiset(E upperBound, BoundType boundType)
SortedMultiset
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 ImmutableSortedMultiset<E> subMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)
SortedMultiset
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 abstract ImmutableSortedMultiset<E> tailMultiset(E lowerBound, BoundType boundType)
SortedMultiset
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 static <E> ImmutableSortedMultiset.Builder <E> orderedBy(Comparator <E> comparator)
SortedMultiset<Integer>
with a
Comparator<Number>
, use the
ImmutableSortedMultiset.Builder
constructor instead.
NullPointerException
- if
comparator
is null
public static <E extends Comparable<?>> ImmutableSortedMultiset .Builder <E> reverseOrder()
Note: the type parameter E
extends Comparable<?>
rather than Comparable<? super E>
as a workaround for javac bug 6468354.
public static <E extends Comparable<?>> ImmutableSortedMultiset .Builder <E> naturalOrder()
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>
as a workaround for javac bug 6468354.
@Deprecated public static <E> ImmutableSortedMultiset.Builder <E> builder()
naturalOrder()
, which offers better type-safety.
naturalOrder()
, which offers better type-safety, instead. This method exists only to hide
ImmutableMultiset.builder()
from consumers of
ImmutableSortedMultiset
.
UnsupportedOperationException
- always