@GwtCompatible(serializable=true) public abstract class ImmutableMultiset<E> extends ImmutableCollection<E> implements Multiset<E>
Its iterator orders elements according to the first appearance of the element among the items passed to the factory method or builder. When the multiset contains multiple instances of an element, those instances are consecutive in the iteration order.
See the Guava User Guide article on immutable collections.
| Modifier and Type | Class and Description |
|---|---|
static class |
ImmutableMultiset.Builder<E>
A builder for creating immutable multiset instances, especially
public static final multisets ("constant multisets"). |
Multiset.Entry<E>| Modifier and Type | Method and Description |
|---|---|
int |
add(E element,
int occurrences)
Deprecated.
Unsupported operation.
|
static <E> ImmutableMultiset.Builder<E> |
builder()
Returns a new builder.
|
boolean |
contains(java.lang.Object object)
Determines whether this multiset contains the specified element.
|
boolean |
containsAll(java.util.Collection<?> targets)
Returns
true if this multiset contains at least one occurrence of
each element in the specified collection. |
static <E> ImmutableMultiset<E> |
copyOf(E[] elements)
Returns an immutable multiset containing the given elements.
|
static <E> ImmutableMultiset<E> |
copyOf(java.lang.Iterable<? extends E> elements)
Returns an immutable multiset containing the given elements.
|
static <E> ImmutableMultiset<E> |
copyOf(java.util.Iterator<? extends E> elements)
Returns an immutable multiset containing the given elements.
|
ImmutableSet<Multiset.Entry<E>> |
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. |
boolean |
equals(java.lang.Object object)
Compares the specified object with this multiset for equality.
|
int |
hashCode()
Returns the hash code for this multiset.
|
UnmodifiableIterator<E> |
iterator()
Returns an unmodifiable iterator across the elements in this collection.
|
static <E> ImmutableMultiset<E> |
of()
Returns the empty immutable multiset.
|
static <E> ImmutableMultiset<E> |
of(E element)
Returns an immutable multiset containing a single element.
|
static <E> ImmutableMultiset<E> |
of(E e1,
E e2)
Returns an immutable multiset containing the given elements, in order.
|
static <E> ImmutableMultiset<E> |
of(E e1,
E e2,
E e3)
Returns an immutable multiset containing the given elements, in order.
|
static <E> ImmutableMultiset<E> |
of(E e1,
E e2,
E e3,
E e4)
Returns an immutable multiset containing the given elements, in order.
|
static <E> ImmutableMultiset<E> |
of(E e1,
E e2,
E e3,
E e4,
E e5)
Returns an immutable multiset containing the given elements, in order.
|
static <E> ImmutableMultiset<E> |
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E... others)
Returns an immutable multiset containing the given elements, in order.
|
int |
remove(java.lang.Object element,
int occurrences)
Deprecated.
Unsupported operation.
|
int |
setCount(E element,
int count)
Deprecated.
Unsupported operation.
|
boolean |
setCount(E element,
int oldCount,
int newCount)
Deprecated.
Unsupported operation.
|
java.lang.String |
toString() |
add, addAll, asList, clear, isEmpty, remove, removeAll, retainAll, toArray, toArrayclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static <E> ImmutableMultiset<E> of()
public static <E> ImmutableMultiset<E> of(E element)
java.lang.NullPointerException - if element is nullpublic static <E> ImmutableMultiset<E> of(E e1, E e2)
java.lang.NullPointerException - if any element is nullpublic static <E> ImmutableMultiset<E> of(E e1, E e2, E e3)
java.lang.NullPointerException - if any element is nullpublic static <E> ImmutableMultiset<E> of(E e1, E e2, E e3, E e4)
java.lang.NullPointerException - if any element is nullpublic static <E> ImmutableMultiset<E> of(E e1, E e2, E e3, E e4, E e5)
java.lang.NullPointerException - if any element is nullpublic static <E> ImmutableMultiset<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E... others)
java.lang.NullPointerException - if any element is nullpublic static <E> ImmutableMultiset<E> copyOf(E[] elements)
The multiset is ordered by the first occurrence of each element. For
example, ImmutableMultiset.copyOf([2, 3, 1, 3]) yields a multiset
with elements in the order 2, 3, 3, 1.
java.lang.NullPointerException - if any of elements is nullpublic static <E> ImmutableMultiset<E> copyOf(java.lang.Iterable<? extends E> elements)
The multiset is ordered by the first occurrence of each element. For
example, ImmutableMultiset.copyOf(Arrays.asList(2, 3, 1, 3)) yields
a multiset with elements in the order 2, 3, 3, 1.
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.
Note: Despite what the method name suggests, if elements
is an ImmutableMultiset, no copy will actually be performed, and
the given multiset itself will be returned.
java.lang.NullPointerException - if any of elements is nullpublic static <E> ImmutableMultiset<E> copyOf(java.util.Iterator<? extends E> elements)
The multiset is ordered by the first occurrence of each element. For
example,
ImmutableMultiset.copyOf(Arrays.asList(2, 3, 1, 3).iterator())
yields a multiset with elements in the order 2, 3, 3, 1.
java.lang.NullPointerException - if any of elements is nullpublic UnmodifiableIterator<E> iterator()
ImmutableCollectionpublic boolean contains(@Nullable
java.lang.Object object)
MultisetThis method refines Collection.contains(java.lang.Object) to further specify that
it may not throw an exception in response to element being
null or of the wrong type.
public boolean containsAll(java.util.Collection<?> targets)
Multisettrue if this multiset contains at least one occurrence of
each element in the specified collection.
This method refines Collection.containsAll(java.util.Collection<?>) to further specify
that it may not throw an exception in response to any of elements being null or of the wrong type.
Note: this method does not take into account the occurrence
count of an element in the two collections; it may still return true even if elements contains several occurrences of an element
and this multiset contains only one. This is no different than any other
collection type like List, but it may be unexpected to the user of
a multiset.
containsAll in interface java.util.Collection<E>containsAll in interface Multiset<E>containsAll in class ImmutableCollection<E>targets - the collection of elements to be checked for containment in
this multisettrue if this multiset contains at least one occurrence of
each element contained in elements@Deprecated public final int add(E element, int occurrences)
add in interface Multiset<E>element - the element to add occurrences of; may be null only if
explicitly allowed by the implementationoccurrences - the number of occurrences of the element to add. May be
zero, in which case no change will be made.java.lang.UnsupportedOperationException - always@Deprecated
public final int remove(java.lang.Object element,
int occurrences)
remove in interface Multiset<E>element - the element to conditionally remove occurrences ofoccurrences - the number of occurrences of the element to remove. May
be zero, in which case no change will be made.java.lang.UnsupportedOperationException - always@Deprecated public final int setCount(E element, int count)
setCount in interface Multiset<E>element - the element to add or remove occurrences of; may be null
only if explicitly allowed by the implementationcount - the desired count of the element in this multisetjava.lang.UnsupportedOperationException - always@Deprecated public final boolean setCount(E element, int oldCount, int newCount)
setCount in interface Multiset<E>element - the element to conditionally set the count of; may be null
only if explicitly allowed by the implementationoldCount - the expected present count of the element in this multisetnewCount - the desired count of the element in this multisettrue if the condition for modification was met. This
implies that the multiset was indeed modified, unless
oldCount == newCount.java.lang.UnsupportedOperationException - alwayspublic boolean equals(@Nullable
java.lang.Object object)
Multisettrue if the given object is also a multiset and contains equal
elements with equal counts, regardless of order.public int hashCode()
Multiset ((element == null) ? 0 : element.hashCode()) ^ count(element)
over all distinct elements in the multiset. It follows that a multiset and
its entry set always have the same hash code.public java.lang.String toString()
MultisetIt is recommended, though not mandatory, that this method return the
result of invoking Multiset.toString() on the Multiset.entrySet(), yielding a
result such as [a x 3, c, d x 2, e].
public ImmutableSet<Multiset.Entry<E>> entrySet()
MultisetMultiset.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
Multiset.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.
public static <E> ImmutableMultiset.Builder<E> builder()
ImmutableMultiset.Builder constructor.