public static final class ImmutableSortedSet.Builder<E> extends ImmutableSet.Builder<E>
A builder for creating immutable sorted set instances, especially public static final
sets (“constant sets”), with a given comparator. Example:
public static final ImmutableSortedSet<Number> LUCKY_NUMBERS =
new ImmutableSortedSet.Builder<Number>(ODDS_FIRST_COMPARATOR)
.addAll(SINGLE_DIGIT_PRIMES)
.add(42)
.build();
Builder instances can be reused; it is safe to call build()
multiple times to build multiple sets in series. Each set is a superset of the set created before it.
Constructor and Description |
---|
Builder(Comparator<? super E> comparator)
Creates a new builder.
|
Builder(int initialCapacity,
Comparator<? super E> comparator)
Creates a new builder with the given initialCapacity.
|
Modifier and Type | Method and Description |
---|---|
ImmutableSortedSet.Builder<E> |
add(E... elements)
Adds each element of
elements to the ImmutableSortedSet , ignoring duplicate elements (only the first duplicate element is added). |
ImmutableSortedSet.Builder<E> |
add(E element)
Adds
element to the ImmutableSortedSet . |
ImmutableSortedSet.Builder<E> |
addAll(Iterable<? extends E> elements)
Adds each element of
elements to the ImmutableSortedSet , ignoring duplicate elements (only the first duplicate element is added). |
ImmutableSortedSet.Builder<E> |
addAll(Iterator<? extends E> elements)
Adds each element of
elements to the ImmutableSortedSet , ignoring duplicate elements (only the first duplicate element is added). |
ImmutableSortedSet<E> |
build()
Returns a newly-created
ImmutableSortedSet based on the contents of the Builder and its comparator. |
public Builder(Comparator<? super E> comparator)
Creates a new builder. The returned builder is equivalent to the builder generated by ImmutableSortedSet.orderedBy(java.util.Comparator<E>)
.
public Builder(int initialCapacity, Comparator<? super E> comparator)
Creates a new builder with the given initialCapacity.
public ImmutableSortedSet.Builder<E> add(E element)
Adds element
to the ImmutableSortedSet
. If the ImmutableSortedSet
already contains element
, then add
has no effect. (only the previously added element is retained).
add
in class ImmutableSet.Builder<E>
element
- the element to addBuilder
objectNullPointerException
- if element
is nullpublic ImmutableSortedSet.Builder<E> add(E... elements)
Adds each element of elements
to the ImmutableSortedSet
, ignoring duplicate elements (only the first duplicate element is added).
add
in class ImmutableSet.Builder<E>
elements
- the elements to addBuilder
objectNullPointerException
- if elements
contains a null elementpublic ImmutableSortedSet.Builder<E> addAll(Iterable<? extends E> elements)
Adds each element of elements
to the ImmutableSortedSet
, ignoring duplicate elements (only the first duplicate element is added).
addAll
in class ImmutableSet.Builder<E>
elements
- the elements to add to the ImmutableSortedSet
Builder
objectNullPointerException
- if elements
contains a null elementpublic ImmutableSortedSet.Builder<E> addAll(Iterator<? extends E> elements)
Adds each element of elements
to the ImmutableSortedSet
, ignoring duplicate elements (only the first duplicate element is added).
addAll
in class ImmutableSet.Builder<E>
elements
- the elements to add to the ImmutableSortedSet
Builder
objectNullPointerException
- if elements
contains a null elementpublic ImmutableSortedSet<E> build()
Returns a newly-created ImmutableSortedSet
based on the contents of the Builder
and its comparator.
build
in class ImmutableSet.Builder<E>