Interface Stream.Builder<T>
-
- 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 aStream. This allows the creation of aStreamby generating elements individually and adding them to theBuilder(without the copying overhead that comes from using anArrayListas 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 orderedStreamwhose 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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method and Description voidaccept(T t)Adds an element to the stream being built.default Stream.Builder<T>add(T t)Adds an element to the stream being built.Stream<T>build()Builds the stream, transitioning this builder to the built state.
-
-
-
Method Detail
accept
void accept(T t)
Adds an element to the stream being built.- Specified by:
-
acceptin interfaceConsumer<T> - Parameters:
-
t- the input argument - Throws:
-
IllegalStateException- if the builder has already transitioned to the built state
add
default Stream.Builder<T> add(T t)
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:
-
thisbuilder - Throws:
-
IllegalStateException- if the builder has already transitioned to the built state
build
Stream<T> build()
Builds the stream, transitioning this builder to the built state. AnIllegalStateExceptionis 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
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
