Record Class StreamableInterceptConfig<T>

java.lang.Object

java.lang.Record

io.reactivex.rxjava4.core.config.StreamableInterceptConfig<T>

Type Parameters:

T - the element type of the sequence

Record Components:

onStream - called when the Streamable.stream(StreamerCancellation) is invoked

onNext - called when the Streamer.next() is invoked

onCurrent - called when the Streamer.current() is invoked

onFinish - called when the Streamer.finish() is invoked

public record StreamableInterceptConfig<T>(@NonNull BiFunction<? super StreamerCancellation, ? super Streamer<? extends T>, ? extends Streamer<? extends T>> onStream, @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext, @NonNull Function<? super T, ? extends T> onCurrent, @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Void>, ? extends CompletionStage<Void>> onFinish)
extends Record

Configuration record the intercept() operator with various lifecylce-stage transforming callbacks

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
StreamableInterceptConfig(@NonNull BiFunction<? super StreamerCancellation, ? super Streamer<? extends T>, ? extends Streamer<? extends T>> onStream, @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext, @NonNull Function<? super T, ? extends T> onCurrent, @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Void>, ? extends CompletionStage<Void>> onFinish)	Constructs a fully configured record.
StreamableInterceptConfig(@NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext)	Constructs a configuration with a custom onNext() intercept and everything else is pass-through.
StreamableInterceptConfig(@NonNull Function<? super T, ? extends T> onCurrent)	Constructs a configuration with a custom onCurrent() intercept and everything else is pass-through.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NonNull Function<? super T, ? extends T>	onCurrent()	Returns the value of the onCurrent record component.
@NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Void>, ? extends CompletionStage<Void>>	onFinish()	Returns the value of the onFinish record component.
@NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>>	onNext()	Returns the value of the onNext record component.
@NonNull BiFunction<? super StreamerCancellation, ? super Streamer<? extends T>, ? extends Streamer<? extends T>>	onStream()	Returns the value of the onStream record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StreamableInterceptConfig

public StreamableInterceptConfig(@NonNull
 @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext)

Constructs a configuration with a custom onNext() intercept and everything else is pass-through.

Parameters:

onNext - the callback for intercepting the next() calls

StreamableInterceptConfig

public StreamableInterceptConfig(@NonNull
 @NonNull Function<? super T, ? extends T> onCurrent)

Constructs a configuration with a custom onCurrent() intercept and everything else is pass-through.

Parameters:

onCurrent - the callback for when an item is ready

StreamableInterceptConfig

public StreamableInterceptConfig(@NonNull
 @NonNull BiFunction<? super StreamerCancellation, ? super Streamer<? extends T>, ? extends Streamer<? extends T>> onStream,
 @NonNull
 @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext,
 @NonNull
 @NonNull Function<? super T, ? extends T> onCurrent,
 @NonNull
 @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Void>, ? extends CompletionStage<Void>> onFinish)

Constructs a fully configured record.

Parameters:

onStream - called when the Streamable.stream(StreamerCancellation) is invoked

onNext - called when the Streamer.next() is invoked

onCurrent - called when the Streamer.current() is invoked

onFinish - called when the Streamer.finish() is invoked

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

onStream

@NonNull
public @NonNull BiFunction<? super StreamerCancellation, ? super Streamer<? extends T>, ? extends Streamer<? extends T>> onStream()

Returns the value of the onStream record component.

Returns:

the value of the onStream record component

onNext

@NonNull
public @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Boolean>, ? extends CompletionStage<Boolean>> onNext()

Returns the value of the onNext record component.

Returns:

the value of the onNext record component

onCurrent

@NonNull
public @NonNull Function<? super T, ? extends T> onCurrent()

Returns the value of the onCurrent record component.

Returns:

the value of the onCurrent record component

onFinish

@NonNull
public @NonNull BiFunction<? super StreamerCancellation, ? super CompletionStage<Void>, ? extends CompletionStage<Void>> onFinish()

Returns the value of the onFinish record component.

Returns:

the value of the onFinish record component