Package com.google.common.collect
Class ImmutableCollection.Builder<E>
- java.lang.Object
-
- com.google.common.collect.ImmutableCollection.Builder<E>
-
- Direct Known Subclasses:
ImmutableList.Builder
,ImmutableMultiset.Builder
,ImmutableSet.Builder
- Enclosing class:
- ImmutableCollection<E>
@DoNotMock public abstract static class ImmutableCollection.Builder<E> extends java.lang.Object
Abstract base class for builders ofImmutableCollection
types.- Since:
- 10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ImmutableCollection.Builder<E>
add(E element)
Addselement
to theImmutableCollection
being built.ImmutableCollection.Builder<E>
add(E... elements)
Adds each element ofelements
to theImmutableCollection
being built.ImmutableCollection.Builder<E>
addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableCollection
being built.ImmutableCollection.Builder<E>
addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableCollection
being built.abstract ImmutableCollection<E>
build()
Returns a newly-createdImmutableCollection
of the appropriate type, containing the elements provided to this builder.
-
-
-
Method Detail
-
add
@CanIgnoreReturnValue public abstract ImmutableCollection.Builder<E> add(E element)
Addselement
to theImmutableCollection
being built.Note that each builder class covariantly returns its own type from this method.
- Parameters:
element
- the element to add- Returns:
- this
Builder
instance - Throws:
java.lang.NullPointerException
- ifelement
is null
-
add
@CanIgnoreReturnValue public ImmutableCollection.Builder<E> add(E... elements)
Adds each element ofelements
to theImmutableCollection
being built.Note that each builder class overrides this method in order to covariantly return its own type.
- Parameters:
elements
- the elements to add- Returns:
- this
Builder
instance - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
@CanIgnoreReturnValue public ImmutableCollection.Builder<E> addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableCollection
being built.Note that each builder class overrides this method in order to covariantly return its own type.
- Parameters:
elements
- the elements to add- Returns:
- this
Builder
instance - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
@CanIgnoreReturnValue public ImmutableCollection.Builder<E> addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableCollection
being built.Note that each builder class overrides this method in order to covariantly return its own type.
- Parameters:
elements
- the elements to add- Returns:
- this
Builder
instance - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
build
public abstract ImmutableCollection<E> build()
Returns a newly-createdImmutableCollection
of the appropriate type, containing the elements provided to this builder.Note that each builder class covariantly returns the appropriate type of
ImmutableCollection
from this method.
-
-