public static final class ImmutableList.Builder<E> extends ImmutableCollection.Builder<E>
A builder for creating immutable list instances, especially public
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();
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.
| Constructor and Description |
|---|
Builder()
Creates a new builder.
|
Builder(int initialCapacity)
Creates a new builder with the given initial capacity.
|
| Modifier and Type | Method and Description |
|---|---|
ImmutableList.Builder<E> |
add(E... elements)
Adds each element of
elements to the ImmutableList. |
ImmutableList.Builder<E> |
add(E element)
Adds
element to the ImmutableList. |
ImmutableList.Builder<E> |
addAll(Iterable<? extends E> elements)
Adds each element of
elements to the ImmutableList. |
ImmutableList.Builder<E> |
addAll(Iterator<? extends E> elements)
Adds each element of
elements to the ImmutableList. |
ImmutableList<E> |
build()
Returns a newly-created
ImmutableList based on the contents of the Builder. |
public Builder()
Creates a new builder. The returned builder is equivalent to the builder generated by ImmutableList.builder().
public Builder(int initialCapacity)
Creates a new builder with the given initial capacity. The returned builder is equivalent to the builder generated by ImmutableList.builder(int).
public ImmutableList.Builder<E> add(E element)
Adds element to the ImmutableList.
element - the element to addBuilder objectNullPointerException - if element is nullpublic ImmutableList.Builder<E> addAll(Iterable<? extends E> elements)
Adds each element of elements to the ImmutableList.
elements - the Iterable to add to the ImmutableListBuilder objectNullPointerException - if elements is null or contains a null elementpublic ImmutableList.Builder<E> add(E... elements)
Adds each element of elements to the ImmutableList.
elements - the Iterable to add to the ImmutableListBuilder objectNullPointerException - if elements is null or contains a null elementpublic ImmutableList.Builder<E> addAll(Iterator<? extends E> elements)
Adds each element of elements to the ImmutableList.
addAll in class ImmutableCollection.Builder<E>elements - the Iterable to add to the ImmutableListBuilder objectNullPointerException - if elements is null or contains a null elementpublic ImmutableList<E> build()
Returns a newly-created ImmutableList based on the contents of the Builder.
build in class ImmutableCollection.Builder<E>