Package com.google.common.collect
Class ImmutableList.Builder<E>
- java.lang.Object
-
- com.google.common.collect.ImmutableCollection.Builder<E>
-
- com.google.common.collect.ImmutableList.Builder<E>
-
- Enclosing class:
- ImmutableList<E>
public static final class ImmutableList.Builder<E> extends ImmutableCollection.Builder<E>
A builder for creating immutable list instances, especiallypublic static final
lists ("constant lists"). Example:public static final ImmutableList<Color> GOOGLE_COLORS = new ImmutableList.Builder<Color>() .addAll(WEBSAFE_COLORS) .add(new Color(0, 191, 255)) .build();
Elements appear in the resulting list in the same order they were added to the builder.
Builder instances can be reused; it is safe to call
build()
multiple times to build multiple lists in series. Each new list contains all the elements of the ones created before it.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description Builder()
Creates a new builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImmutableList.Builder<E>
add(E element)
Addselement
to theImmutableList
.ImmutableList.Builder<E>
add(E... elements)
Adds each element ofelements
to theImmutableList
.ImmutableList.Builder<E>
addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableList
.ImmutableList.Builder<E>
addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableList
.ImmutableList<E>
build()
Returns a newly-createdImmutableList
based on the contents of theBuilder
.
-
-
-
Constructor Detail
-
Builder
public Builder()
Creates a new builder. The returned builder is equivalent to the builder generated byImmutableList.builder()
.
-
-
Method Detail
-
add
@CanIgnoreReturnValue public ImmutableList.Builder<E> add(E element)
Addselement
to theImmutableList
.- Specified by:
add
in classImmutableCollection.Builder<E>
- Parameters:
element
- the element to add- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelement
is null
-
add
@CanIgnoreReturnValue public ImmutableList.Builder<E> add(E... elements)
Adds each element ofelements
to theImmutableList
.- Overrides:
add
in classImmutableCollection.Builder<E>
- Parameters:
elements
- theIterable
to add to theImmutableList
- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
@CanIgnoreReturnValue public ImmutableList.Builder<E> addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableList
.- Overrides:
addAll
in classImmutableCollection.Builder<E>
- Parameters:
elements
- theIterable
to add to theImmutableList
- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
@CanIgnoreReturnValue public ImmutableList.Builder<E> addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableList
.- Overrides:
addAll
in classImmutableCollection.Builder<E>
- Parameters:
elements
- theIterator
to add to theImmutableList
- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
build
public ImmutableList<E> build()
Returns a newly-createdImmutableList
based on the contents of theBuilder
.- Specified by:
build
in classImmutableCollection.Builder<E>
-
-