com.google.common.collect.ImmutableCollection<E>
com.google.common.collect.ImmutableMultiset<E>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class ImmutableMultiset<E>
An immutable hash-based multiset. Does not permit null elements.
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.
| Nested Class Summary | |
|---|---|
static class |
ImmutableMultiset.Builder<E>
A builder for creating immutable multiset instances, especially public static final multisets ("constant multisets"). |
| Nested classes/interfaces inherited from interface com.google.common.collect.Multiset |
|---|
Multiset.Entry<E> |
| Method Summary | ||
|---|---|---|
int |
add(E element,
int occurrences)
Guaranteed to throw an exception and leave the collection unmodified. |
|
static
|
builder()
Returns a new builder. |
|
boolean |
contains(Object element)
Returns true if this collection contains the specified element. |
|
static
|
copyOf(E[] elements)
Returns an immutable multiset containing the given elements. |
|
static
|
copyOf(Iterable<? extends E> elements)
Returns an immutable multiset containing the given elements. |
|
static
|
copyOf(Iterator<? extends E> elements)
Returns an immutable multiset containing the given elements. |
|
int |
count(Object element)
Returns the number of occurrences of an element in this multiset (the count of the element). |
|
Set<E> |
elementSet()
Returns the set of distinct elements contained in this multiset. |
|
Set<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(Object object)
Indicates whether some other object is "equal to" this one. |
|
int |
hashCode()
Returns a hash code value for the object. |
|
UnmodifiableIterator<E> |
iterator()
Returns an unmodifiable iterator across the elements in this collection. |
|
static
|
of()
Returns the empty immutable multiset. |
|
static
|
of(E element)
Returns an immutable multiset containing a single element. |
|
static
|
of(E[] elements)
Deprecated. use copyOf(Object[]). |
|
static
|
of(E e1,
E e2)
Returns an immutable multiset containing the given elements, in order. |
|
static
|
of(E e1,
E e2,
E e3)
Returns an immutable multiset containing the given elements, in order. |
|
static
|
of(E e1,
E e2,
E e3,
E e4)
Returns an immutable multiset containing the given elements, in order. |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5)
Returns an immutable multiset containing the given elements, in order. |
|
static
|
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(Object element,
int occurrences)
Guaranteed to throw an exception and leave the collection unmodified. |
|
int |
setCount(E element,
int count)
Guaranteed to throw an exception and leave the collection unmodified. |
|
boolean |
setCount(E element,
int oldCount,
int newCount)
Guaranteed to throw an exception and leave the collection unmodified. |
|
int |
size()
Returns the number of elements in this collection. |
|
String |
toString()
Returns a string representation of the object. |
|
| Methods inherited from class com.google.common.collect.ImmutableCollection |
|---|
add, addAll, asList, clear, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.common.collect.Multiset |
|---|
add, containsAll, remove, removeAll, retainAll |
| Methods inherited from interface java.util.Collection |
|---|
addAll, clear, isEmpty, toArray, toArray |
| Method Detail |
|---|
public static <E> ImmutableMultiset<E> of()
public static <E> ImmutableMultiset<E> of(E element)
NullPointerException - if element is null
public static <E> ImmutableMultiset<E> of(E e1,
E e2)
NullPointerException - if any element is null
public static <E> ImmutableMultiset<E> of(E e1,
E e2,
E e3)
NullPointerException - if any element is null
public static <E> ImmutableMultiset<E> of(E e1,
E e2,
E e3,
E e4)
NullPointerException - if any element is null
public static <E> ImmutableMultiset<E> of(E e1,
E e2,
E e3,
E e4,
E e5)
NullPointerException - if any element is null
public static <E> ImmutableMultiset<E> of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E... others)
NullPointerException - if any element is null@Deprecated public static <E> ImmutableMultiset<E> of(E[] elements)
copyOf(Object[]).
The multiset is ordered by the first occurrence of each element. For
example, ImmutableMultiset.of(2, 3, 1, 3) yields a multiset with
elements in the order 2, 3, 3, 1.
NullPointerException - if any of elements 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.
NullPointerException - if any of elements is nullpublic static <E> ImmutableMultiset<E> copyOf(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.
Note that if c is a Collection<String>, then ImmutableMultiset.copyOf(c) returns an ImmutableMultiset<String>
containing each of the strings in c, while
ImmutableMultiset.of(c) returns an
ImmutableMultiset<Collection<String>> containing one element (the
given collection itself).
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.
NullPointerException - if any of elements is nullpublic static <E> ImmutableMultiset<E> copyOf(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.
NullPointerException - if any of elements is null
public int count(@Nullable
Object element)
MultisetObject.equals(java.lang.Object)-based
multiset, this gives the same result as Collections.frequency(java.util.Collection, java.lang.Object)
(which would presumably perform more poorly).
Note: the utility method Iterables.frequency(java.lang.Iterable, java.lang.Object) generalizes
this operation; it correctly delegates to this method when dealing with a
multiset, but it can also accept any other iterable type.
count in interface Multiset<E>element - the element to count occurrences of
public UnmodifiableIterator<E> iterator()
ImmutableCollection
iterator in interface Multiset<E>iterator in interface Iterable<E>iterator in interface Collection<E>iterator in class ImmutableCollection<E>public int size()
java.util.Collection
size in interface Collection<E>
public boolean contains(@Nullable
Object element)
java.util.Collection
contains in interface Multiset<E>contains in interface Collection<E>contains in class ImmutableCollection<E>element - element whose presence in this collection is to be tested
public 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.
UnsupportedOperationException - always
public int remove(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.
UnsupportedOperationException - always
public 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 multiset
UnsupportedOperationException - always
public 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 multiset
true if the condition for modification was met. This
implies that the multiset was indeed modified, unless
oldCount == newCount.
UnsupportedOperationException - always
public boolean equals(@Nullable
Object object)
java.lang.Object
The equals method implements an equivalence relation
on non-null object references:
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
equals in interface Multiset<E>equals in interface Collection<E>equals in class Objectobject - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Object.hashCode(),
HashMappublic int hashCode()
java.lang.ObjectHashMap.
The general contract of hashCode is:
hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
hashCode in interface Multiset<E>hashCode in interface Collection<E>hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)public String toString()
java.lang.ObjecttoString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
toString in interface Multiset<E>toString in class ImmutableCollection<E>public Set<E> elementSet()
MultisetIf 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().
elementSet in interface Multiset<E>public Set<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.
entrySet in interface Multiset<E>public static <E> ImmutableMultiset.Builder<E> builder()
ImmutableMultiset.Builder constructor.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||