Interface StreamProcessor<In,Out>

Type Parameters:

In - the element type of the input side

Out - the element type of the output side

All Superinterfaces:

Streamable<Out>, StreamSink<In>

All Known Implementing Classes:

DispatchStreamProcessor

public interface StreamProcessor<@NonNull In, @NonNull Out>
extends Streamable<Out>, StreamSink<In>

A Flow.Processor-like interface combining the Streamable interface and the StreamSink interface to establish a push-pull bridge based on CompletionStage-based asynchronous processing and dispatching of values and errors.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
@Nullable Throwable	getThrowable()	Returns the terminal Throwable if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).
boolean	hasComplete()	Returns true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).
boolean	hasStreamers()	Returns true if this StreamProcessor has Streamers.
boolean	hasThrowable()	Returns true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).
int	streamerCount()	Returns the current number of Streamers subscribed to this StreamProcessor

Methods inherited from interface Streamable

blockingFirst, blockingLast, collect, delay, doOnError, doOnNext, filter, flatMap, forEach, forEach, forEach, forEach, forEach, groupBy, hide, ignoreElements, intercept, last, lastOrError, lift, map, mapOptional, onErrorResumeNext, repeat, repeatWhen, retry, retry, retry, retryWhen, skip, stream, subscribe, subscribe, subscribe, subscribe, take, takeUntil, takeWhile, test, test, timeout, to, toFlowable, toFlowable, toObservable, transform, transform

Modifier and Type	Method	Description
default Out	blockingFirst()	Blocks the current thread until this Streamable produces one item, which is then returned.
default Out	blockingLast()	Blocks the current thread until this Streamable produces all of its items and the very last is then returned.
default <A,R> @NonNull Streamable<R>	collect(@NonNull Collector<@NonNull Out, A, R> collector)	Collects all upstream values via the use of a Collector configuration and emits its resulting value as a single item of the returned Streamable.
default @NonNull Streamable<Out>	delay(long time, @NonNull TimeUnit unit, @NonNull Scheduler scheduler)	Delays the delivery of each upstream item by the given time amount.
default @NonNull Streamable<Out>	doOnError(@NonNull Consumer<? super Throwable> consumer)	Calls the specific Consumer if there is an error from the upstream.
default @NonNull Streamable<Out>	doOnNext(@NonNull Consumer<? super @NonNull Out> consumer)	Calls the given consumer whenever an upstream item becomes available.
default @NonNull Streamable<Out>	filter(@NonNull Predicate<? super @NonNull Out> predicate)	Filters out the upstream items that do not pass the given predicate.
default <R> @NonNull Streamable<R>	flatMap(@NonNull Function<? super @NonNull Out, ? extends Streamable<? extends R>> mapper, @NonNull StandardConcurrentConfig config)	Maps each upstream item onto a Streamable and runs them concurrently while relaying inner items as first-come-first-served manner.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull BiConsumer<? super @NonNull Out, ? super Disposable> consumer, @NonNull DisposableStreamerCancellation canceller, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull Out> consumer)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull Out> consumer, @NonNull DisposableStreamerCancellation canceller)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull Out> consumer, @NonNull DisposableStreamerCancellation canceller, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull Out> consumer, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default <@Nullable K> @NonNull Streamable<GroupedStreamable<K,Out>>	groupBy(@NonNull Function<? super @NonNull Out, ? extends @Nullable K> keySelector)	Maps each upstream item into a GroupedStreamable group, emits those groups and keeps relaying the upstream items into those groups.
default @NonNull Streamable<Out>	hide()	Hides the identity of this Streamable and its Streamer.
default @NonNull Streamable<Out>	ignoreElements()	Ignores all elements from the current Streamable and completes.
default @NonNull Streamable<Out>	intercept(StreamableInterceptConfig<@NonNull Out> config)	Intercepts the lifecycle method calls of Streamable and Streamer and allows the modification of them via Function callbacks.
default @NonNull Single<Out>	last(@NonNull Out defaultItem)	Signals the last item from the upstream Streamable or the provided defaultItem if the upstream is empty, as a Single instance.
default @NonNull Single<Out>	lastOrError()	Signals the last item from the upstream Streamable or a NoSuchElementException if the upstream is empty, as a Single instance.
default <@NonNull R> @NonNull Streamable<R>	lift(@NonNull StreamableOperator<? super @NonNull Out, ? extends @NonNull R> lifter)	This method requires advanced knowledge about building operators, please consider other standard composition methods first; Returns a Streamable instance which when its Streamable.stream(StreamerCancellation) is invoked, applies the specified operator callback to the upstream Streamer to produce an actual Streamer instance to be handed downstream.
default <@NonNull R> @NonNull Streamable<R>	map(@NonNull Function<? super @NonNull Out, ? extends @NonNull R> mapper)	Maps each upstream item into another item via a mapper function.
default <@NonNull R> @NonNull Streamable<R>	mapOptional(@NonNull Function<? super @NonNull Out, ? extends Optional<? extends @NonNull R>> mapper)	Maps each upstream item into another, optional item via a mapper function that skips the empty optionals.
default @NonNull Streamable<Out>	onErrorResumeNext(@NonNull Function<? super Throwable, ? extends Streamable<? extends @NonNull Out>> fallbackMapper)	When the upstream fails, the sequence is resumed by the Streamable that is returned for the failure Throwable.
default @NonNull Streamable<Out>	repeat(long count)	Runs the upstream at most the given count times while it succeeds.
default @NonNull Streamable<Out>	repeatWhen(Function<? super Long, ? extends CompletionStage<Boolean>> whenFunction)	Repeats the upstream when the given function signals true via the CompletionStage for the count how many times the upstream was streamed.
default @NonNull Streamable<Out>	retry(long count)	Retries at most the given count times the upstream if it fails with any error.
default @NonNull Streamable<Out>	retry(BiPredicate<? super Long, ? super Throwable> predicate)	Retries the upstream if the given predicate returns true for the failure count and Throwable of the last streaming of the upstream.
default @NonNull Streamable<Out>	retry(Predicate<? super Throwable> predicate)	Retries the upstream if the given predicate returns true for the failure Throwable of the last streaming of the upstream.
default @NonNull Streamable<Out>	retryWhen(BiFunction<? super Long, ? super Throwable, ? extends CompletionStage<Boolean>> whenFunction)	Retries the upstream when the given predicate signals true via the CompletionStage for the failure count and Throwable of the last streaming of the upstream.
default @NonNull Streamable<Out>	skip(long count)	Skips the first count items and relays the rest to the downstream.
@NonNull Streamer<Out>	stream(@NonNull StreamerCancellation cancellation)	Realizes the stream and returns an interface that lets one consume it.
default @NonNull CompletionStage<Void>	subscribe(@NonNull StreamSink<? super @NonNull Out> consumer)	Relays the events of the upstream into a StreamSink consumer via the help of the standard Executors.newVirtualThreadPerTaskExecutor() as a mediator for pull-to-push.
default @NonNull CompletionStage<Void>	subscribe(@NonNull StreamSink<? super @NonNull Out> consumer, ExecutorService executor)	Relays the events of the upstream into a StreamSink consumer via the help of the given ExecutorService as a mediator for pull-to-push.
default void	subscribe(Flow.Subscriber<? super @NonNull Out> subscriber)	Consume this Streamable via the given flow-reactive-streams subscriber on a virtual thread backed executor service.
default void	subscribe(Flow.Subscriber<? super @NonNull Out> subscriber, @NonNull ExecutorService executor)	Consume this Streamable via the given flow-reactive-streams subscriber.
default @NonNull Streamable<Out>	take(long count)	Takes at most the given number of items from the upstream and relays it to the downstream, then cancels the rest of the sequence.
default <U> @NonNull Streamable<Out>	takeUntil(@NonNull Streamable<U> other)	Relays items from this Streamable until the other Streamable signals an item or completes.
default @NonNull Streamable<Out>	takeWhile(@NonNull Predicate<? super @NonNull Out> predicate)	Relays items from this Streamable while the predicate returns true
default @NonNull TestSubscriber<Out>	test()	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull TestSubscriber<Out>	test(@NonNull ExecutorService executor)	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull Streamable<Out>	timeout(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler, @NonNull Streamable<@NonNull Out> fallback)	Applies a timeout to each upstream item and switches to the fallback Streamable if the upstream doesn't produce an item within the given timeout period.
default <@NonNull R> R	to(@NonNull StreamableConverter<@NonNull Out, ? extends @NonNull R> converter)	Calls the specified converter function during assembly time and returns its resulting value.
default @NonNull Flowable<Out>	toFlowable()	Converts the streamable into a Flowable representation, running on the default Executors.newVirtualThreadPerTaskExecutor() virtual thread.
default @NonNull Flowable<Out>	toFlowable(@NonNull ExecutorService executor)	Converts this Streamable into a Flowable representation, running on the provided executor service.
default @NonNull Observable<Out>	toObservable()	Converts this Streamable into a Observable representation, emitting items on whatever thread produces items in the current Streamable.
default <@NonNull R> @NonNull Streamable<R>	transform(@NonNull VirtualTransformer<@NonNull Out, @NonNull R> transformer)	Transforms the upstream sequence into zero or more elements for the downstream.
default <@NonNull R> @NonNull Streamable<R>	transform(@NonNull VirtualTransformer<@NonNull Out, @NonNull R> transformer, @NonNull ExecutorService executor)	Transforms the upstream sequence into zero or more elements for the downstream.

Methods inherited from interface StreamSink

awaitFinish, awaitNext, cancellation, finish, next, withCancellation

Modifier and Type	Method	Description
default void	awaitFinish(Throwable throwable)	Offer the final, terminal event and then awaits its consumption in a blocking fashion.
default boolean	awaitNext(@NonNull In item)	Offers the given item and then awaits its consumption in a blocking fashion.
default @NonNull DisposableStreamerCancellation	cancellation()	Returns the DisposableContainer to use to detect if the consumer has indicated no more items it is willing to accept.
@NonNull CompletionStage<Void>	finish(@Nullable Throwable throwable)	Offer the final, terminal event.
@NonNull CompletionStage<Boolean>	next(@NonNull In item)	Offer the next item.
default @NonNull StreamSink<In>	withCancellation(DisposableStreamerCancellation cancellation)	Returns a new StreamSink that returns the given DisposableStreamerCancellation in its StreamSink.cancellation(), allowing overriding the cancellation management of this StreamSink

Method Details

hasStreamers

boolean hasStreamers()

Returns true if this StreamProcessor has Streamers.

Returns:

true if this StreamProcessor has Streamers.

streamerCount

int streamerCount()

Returns the current number of Streamers subscribed to this StreamProcessor

Returns:

the current number of Streamers subscribed to this StreamProcessor

hasComplete

boolean hasComplete()

Returns true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).

Returns:

true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).

hasThrowable

boolean hasThrowable()

Returns true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

Returns:

true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

getThrowable

@Nullable
@Nullable Throwable getThrowable()

Returns the terminal Throwable if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

Returns:

the Throwable if any