|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableCollection.Builder<E>
com.google.common.collect.ImmutableMultiset.Builder<E>
public static class ImmutableMultiset.Builder<E>
A builder for creating immutable multiset instances, especially public static final multisets ("constant multisets"). Example:
public static final ImmutableMultiset<Bean> BEANS =
new ImmutableMultiset.Builder<Bean>()
.addCopies(Bean.COCOA, 4)
.addCopies(Bean.GARDEN, 6)
.addCopies(Bean.RED, 8)
.addCopies(Bean.BLACK_EYED, 10)
.build();
Builder instances can be reused; it is safe to call build() multiple
times to build multiple multisets in series.
| Constructor Summary | |
|---|---|
ImmutableMultiset.Builder()
Creates a new builder. |
|
| Method Summary | |
|---|---|
ImmutableMultiset.Builder<E> |
add(E... elements)
Adds each element of elements to the ImmutableMultiset. |
ImmutableMultiset.Builder<E> |
add(E element)
Adds element to the ImmutableMultiset. |
ImmutableMultiset.Builder<E> |
addAll(Iterable<? extends E> elements)
Adds each element of elements to the ImmutableMultiset. |
ImmutableMultiset.Builder<E> |
addAll(Iterator<? extends E> elements)
Adds each element of elements to the ImmutableMultiset. |
ImmutableMultiset.Builder<E> |
addCopies(E element,
int occurrences)
Adds a number of occurrences of an element to this ImmutableMultiset. |
ImmutableMultiset<E> |
build()
Returns a newly-created ImmutableMultiset based on the contents
of the Builder. |
ImmutableMultiset.Builder<E> |
setCount(E element,
int count)
Adds or removes the necessary occurrences of an element such that the element attains the desired count. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ImmutableMultiset.Builder()
ImmutableMultiset.builder().
| Method Detail |
|---|
public ImmutableMultiset.Builder<E> add(E element)
element to the ImmutableMultiset.
add in class ImmutableCollection.Builder<E>element - the element to add
Builder object
NullPointerException - if element is null
public ImmutableMultiset.Builder<E> addCopies(E element,
int occurrences)
ImmutableMultiset.
element - the element to addoccurrences - the number of occurrences of the element to add. May
be zero, in which case no change will be made.
Builder object
NullPointerException - if element is null
IllegalArgumentException - if occurrences is negative, or
if this operation would result in more than Integer.MAX_VALUE
occurrences of the element
public ImmutableMultiset.Builder<E> setCount(E element,
int count)
element - the element to add or remove occurrences ofcount - the desired count of the element in this multiset
Builder object
NullPointerException - if element is null
IllegalArgumentException - if count is negativepublic ImmutableMultiset.Builder<E> add(E... elements)
elements to the ImmutableMultiset.
add in class ImmutableCollection.Builder<E>elements - the elements to add
Builder object
NullPointerException - if elements is null or contains a
null elementpublic ImmutableMultiset.Builder<E> addAll(Iterable<? extends E> elements)
elements to the ImmutableMultiset.
addAll in class ImmutableCollection.Builder<E>elements - the Iterable to add to the ImmutableMultiset
Builder object
NullPointerException - if elements is null or contains a
null elementpublic ImmutableMultiset.Builder<E> addAll(Iterator<? extends E> elements)
elements to the ImmutableMultiset.
addAll in class ImmutableCollection.Builder<E>elements - the elements to add to the ImmutableMultiset
Builder object
NullPointerException - if elements is null or contains a
null elementpublic ImmutableMultiset<E> build()
ImmutableMultiset based on the contents
of the Builder.
build in class ImmutableCollection.Builder<E>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||