Class GroupedStreamable<K,T>

java.lang.Object

io.reactivex.rxjava4.core.GroupedStreamable<K,T>

Type Parameters:

K - the type of the key, can be null

T - the type of the items emitted by the GroupedStreamable

All Implemented Interfaces:

Streamable<T>

public abstract class GroupedStreamable<@Nullable K, @NonNull T>
extends Object
implements Streamable<T>

An Streamable that has been grouped by key, the value of which can be obtained with getKey().

Since:

4.0.0

See Also:

• Streamable.groupBy(io.reactivex.rxjava4.functions.Function)
• ReactiveX documentation: GroupBy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupedStreamable(@Nullable K key)	Constructs a GroupedStreamable with the given key.

Method Summary

Modifier and Type	Method	Description
K	getKey()	Returns the key that identifies the group of items emitted by this GroupedStreamable.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Streamable

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

Modifier and Type	Method	Description
default T	blockingFirst()	Blocks the current thread until this Streamable produces one item, which is then returned
default <A,R> @NonNull Streamable<R>	collect(@NonNull Collector<@NonNull T, 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<T>	delay(long time, @NonNull TimeUnit unit, @NonNull Scheduler scheduler)	Delays the delivery of each upstream item by the given time amount.
default @NonNull Streamable<T>	doOnError(@NonNull Consumer<? super Throwable> consumer)	Calls the specific Consumer if there is an error from the upstream.
default @NonNull Streamable<T>	doOnNext(@NonNull Consumer<? super @NonNull T> consumer)	Calls the given consumer whenever an upstream item becomes available.
default @NonNull Streamable<T>	filter(@NonNull Predicate<? super @NonNull T> predicate)	Filters out the upstream items that do not pass the given predicate.
default <R> @NonNull Streamable<R>	flatMap(@NonNull Function<? super @NonNull T, ? 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 T, ? 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 T> consumer)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull T> consumer, @NonNull DisposableStreamerCancellation canceller)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super @NonNull T> 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 T> consumer, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default <@Nullable K> @NonNull Streamable<GroupedStreamable<K,T>>	groupBy(@NonNull Function<? super @NonNull T, ? 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<T>	hide()	Hides the identity of this Streamable and its Streamer.
default @NonNull Streamable<T>	intercept(StreamableInterceptConfig<@NonNull T> config)	Intercepts the lifecycle method calls of Streamable and Streamer and allows the modification of them via Function callbacks.
default @NonNull Single<T>	last(@NonNull T 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<T>	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 T, ? 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 T, ? 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 T, ? 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<T>	onErrorResumeNext(@NonNull Function<? super Throwable, ? extends Streamable<? extends @NonNull T>> fallbackMapper)	When the upstream fails, the sequence is resumed by the Streamable that is returned for the failure Throwable.
default @NonNull Streamable<T>	skip(long count)	Skips the first count items and relays the rest to the downstream.
@NonNull Streamer<T>	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 T> 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 T> 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 T> 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 T> subscriber, @NonNull ExecutorService executor)	Consume this Streamable via the given flow-reactive-streams subscriber.
default @NonNull Streamable<T>	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<T>	takeUntil(@NonNull Streamable<U> other)	Relays items from this Streamable until the other Streamable signals an item or completes.
default @NonNull Streamable<T>	takeWhile(@NonNull Predicate<? super @NonNull T> predicate)	Relays items from this Streamable while the predicate returns true
default @NonNull TestSubscriber<T>	test()	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull TestSubscriber<T>	test(@NonNull ExecutorService executor)	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull Streamable<T>	timeout(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler, @NonNull Streamable<@NonNull T> 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 T, ? extends @NonNull R> converter)	Calls the specified converter function during assembly time and returns its resulting value.
default @NonNull Flowable<T>	toFlowable()	Converts the streamable into a Flowable representation, running on the default Executors.newVirtualThreadPerTaskExecutor() virtual thread.
default @NonNull Flowable<T>	toFlowable(@NonNull ExecutorService executor)	Converts this Streamable into a Flowable representation, running on the provided executor service.
default @NonNull Observable<T>	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 T, @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 T, @NonNull R> transformer, @NonNull ExecutorService executor)	Transforms the upstream sequence into zero or more elements for the downstream.

Constructor Details

GroupedStreamable

protected GroupedStreamable(@Nullable
 @Nullable K key)

Constructs a GroupedStreamable with the given key.

Parameters:

key - the key

Method Details

getKey

@Nullable
public K getKey()

Returns the key that identifies the group of items emitted by this GroupedStreamable.

Returns:

the key that the items emitted by this GroupedStreamable were grouped by