Package com.google.common.collect
Class ImmutableSet.Builder<E>
- java.lang.Object
-
- com.google.common.collect.ImmutableCollection.Builder<E>
-
- com.google.common.collect.ImmutableSet.Builder<E>
-
- Direct Known Subclasses:
ImmutableSortedSet.Builder
- Enclosing class:
- ImmutableSet<E>
public static class ImmutableSet.Builder<E> extends ImmutableCollection.Builder<E>
A builder for creatingImmutableSet
instances. Example:static final ImmutableSet<Color> GOOGLE_COLORS = ImmutableSet.<Color>builder() .addAll(WEBSAFE_COLORS) .add(new Color(0, 191, 255)) .build();
Building does not change the state of the builder, so it is still possible to add more elements and to build again.
- 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 ImmutableSet.Builder<E>
add(E element)
Addselement
to theImmutableSet
.ImmutableSet.Builder<E>
add(E... elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).ImmutableSet.Builder<E>
addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).ImmutableSet.Builder<E>
addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).ImmutableSet<E>
build()
Returns a newly-createdImmutableSet
based on the contents of theBuilder
.
-
-
-
Constructor Detail
-
Builder
public Builder()
Creates a new builder. The returned builder is equivalent to the builder generated byImmutableSet.builder()
.
-
-
Method Detail
-
add
public ImmutableSet.Builder<E> add(E element)
Addselement
to theImmutableSet
. If theImmutableSet
already containselement
, thenadd
has no effect (only the previously added element is retained).- Parameters:
element
- the element to add- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelement
is null
-
add
public ImmutableSet.Builder<E> add(E... elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).- Parameters:
elements
- the elements to add- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
public ImmutableSet.Builder<E> addAll(java.lang.Iterable<? extends E> elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).- Parameters:
elements
- theIterable
to add to theImmutableSet
- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
addAll
public ImmutableSet.Builder<E> addAll(java.util.Iterator<? extends E> elements)
Adds each element ofelements
to theImmutableSet
, ignoring duplicate elements (only the first duplicate element is added).- Overrides:
addAll
in classImmutableCollection.Builder<E>
- Parameters:
elements
- the elements to add to theImmutableSet
- Returns:
- this
Builder
object - Throws:
java.lang.NullPointerException
- ifelements
is null or contains a null element
-
build
public ImmutableSet<E> build()
Returns a newly-createdImmutableSet
based on the contents of theBuilder
.- Specified by:
build
in classImmutableCollection.Builder<E>
-
-