- Type Parameters:
T
- the type of stream elements
- All Superinterfaces:
Consumer<T>
public static interface Stream.Builder<T> extends Consumer<T>
A mutable builder for a
Stream
. This allows the creation of a
Stream
by generating elements individually and adding them to the
Builder
(without the copying overhead that comes from using
an ArrayList
as a temporary buffer.)
A stream builder has a lifecycle, which starts in a building
phase, during which elements can be added, and then transitions to a built
phase, after which elements may not be added. The built phase begins
when the build()
method is called, which creates an ordered
Stream
whose elements are the elements that were added to the stream
builder, in the order they were added.
- Since:
- 1.8
- See Also:
Stream.builder()
-
Method Summary
-
Method Details
-
accept
Adds an element to the stream being built.- Specified by:
accept
in interfaceConsumer<T>
- Parameters:
t
- the input argument- Throws:
IllegalStateException
- if the builder has already transitioned to the built state
-
add
Adds an element to the stream being built.- Implementation Requirements:
- The default implementation behaves as if:
accept(t) return this;
- Parameters:
t
- the element to add- Returns:
this
builder- Throws:
IllegalStateException
- if the builder has already transitioned to the built state
-
build
Builds the stream, transitioning this builder to the built state. AnIllegalStateException
is thrown if there are further attempts to operate on the builder after it has entered the built state.- Returns:
- the built stream
- Throws:
IllegalStateException
- if the builder has already transitioned to the built state
-