Record Class Streamer.HiddenStreamer<T>

java.lang.Object

java.lang.Record

io.reactivex.rxjava4.core.Streamer.HiddenStreamer<T>

Type Parameters:

T - the element type of the streamer

All Implemented Interfaces:

Streamer<T>, AutoCloseable

Enclosing interface:

Streamer<T>

public static record Streamer.HiddenStreamer<T>(@NonNull Streamer<T> streamer)
extends Record
implements Streamer<T>

Hides the identity of the Streamer for debug or deoptimization purposes.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface Streamer

Streamer.HiddenStreamer<T>, Streamer.StreamerFinishViaDisposableContainerCanceller<T>

Modifier and Type	Interface	Description
static final record	Streamer.HiddenStreamer<T>	Hides the identity of the Streamer for debug or deoptimization purposes.
static final record	Streamer.StreamerFinishViaDisposableContainerCanceller<T>	Augments the base streamer with a canceller so that it can be injected at the various await calls.

Constructor Summary

Constructors

Constructor	Description
HiddenStreamer(@NonNull Streamer<T> streamer)	Creates an instance of a HiddenStreamer record class.

Method Summary

Modifier and Type	Method	Description
T	current()	Returns the current element if Streamer.next() yielded true.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NonNull CompletionStage<Void>	finish(@NonNull DisposableContainer cancellation)	Called when the stream ends or gets cancelled.
final int	hashCode()	Returns a hash code value for this object.
@NonNull CompletionStage<Boolean>	next(@NonNull DisposableContainer cancellation)	Determine if there are more elements available from the source.
@NonNull Streamer<T>	streamer()	Returns the value of the streamer 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

Methods inherited from interface Streamer

awaitFinish, awaitFinish, awaitNext, awaitNext, close, finishVia, hide, next

Modifier and Type	Method	Description
default void	awaitFinish()	Finish and cleanup the sequence after its completion or cancellation.
default void	awaitFinish(@NonNull DisposableContainer cancellation)	Who cancels the cancellation attempt? Another cancellation attempt!
default boolean	awaitNext()	Moves and awaits the sequence's next element, returns false if there are no more data.
default boolean	awaitNext(@NonNull DisposableContainer cancellation)	Moves and awaits the sequence's next element, returns false if there are no more data.
default void	close()	Make this Streamer a resource and a Closeable, allowing virtually blocking closing.
default Streamer<T>	finishVia(@NonNull DisposableContainer canceller)	Augments the streamer so that the given canceller is injected into the various lifecycle await calls.
default Streamer<T>	hide()	Hides the identity of this Streamer for debug or deoptimization purposes.
default @NonNull CompletionStage<Boolean>	next()	Determine if there are more elements available from the source.

Constructor Details

HiddenStreamer

public HiddenStreamer(@NonNull
 @NonNull Streamer<T> streamer)

Creates an instance of a HiddenStreamer record class.

Parameters:

streamer - the value for the streamer record component

Method Details

next

@NonNull
public @NonNull CompletionStage<Boolean> next(@NonNull
 @NonNull DisposableContainer cancellation)

Description copied from interface: Streamer

Determine if there are more elements available from the source.

Specified by:

next in interface Streamer<T>

Parameters:

cancellation - ability to perform cancellation on a per-virtual-pull request.

Returns:

eventually true or false, indicating availability or termination

current

@NonNull
public T current()

Description copied from interface: Streamer

Returns the current element if Streamer.next() yielded true. Can be called multiple times between Streamer.next() calls.

Specified by:

current in interface Streamer<T>

Returns:

the current element

finish

@NonNull
public @NonNull CompletionStage<Void> finish(@NonNull
 @NonNull DisposableContainer cancellation)

Description copied from interface: Streamer

Called when the stream ends or gets cancelled. Should be always invoked. TODO, this is inherited from IAsyncDisposable in C#...

Specified by:

finish in interface Streamer<T>

Parameters:

cancellation - to cancel a stuck finish operation, just in case.

Returns:

the stage you can await to cleanups to happen

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.

streamer

@NonNull
public @NonNull Streamer<T> streamer()

Returns the value of the streamer record component.

Returns:

the value of the streamer record component