io.smallrye.mutiny.groups

Class MultiOnEvent<T>

java.lang.Object

io.smallrye.mutiny.groups.MultiOnEvent<T>

Type Parameters:

T - the type of item emitted by the Multi

public class MultiOnEvent<T>
extends Object

Allows configuring the action to execute on each type of events emitted by a Multi or by a Subscriber

Constructor Summary

Constructors

Constructor and Description
MultiOnEvent(Multi<T> upstream)

Method Summary

Modifier and Type	Method and Description
Multi<T>	cancellation(Runnable callback) Attaches an action executed when a subscription is cancelled.
MultiOnCompletion<T>	completion() Configures the action to execute when the observed Multi emits the completion event.
Multi<T>	completion(Runnable callback)
MultiOnFailure<T>	failure() Like failure(Predicate) but applied to all failures fired by the upstream multi.
MultiOnFailure<T>	failure(Class<? extends Throwable> typeOfFailure) Configures a type of failure filtering the failures on which the behavior (specified with the returned MultiOnFailure) is applied.
MultiOnFailure<T>	failure(Predicate<? super Throwable> predicate) Configures a predicate filtering the failures on which the behavior (specified with the returned MultiOnFailure) is applied.
MultiOnItem<T>	item() Configures the action to execute when the observed Multi emits an item.
MultiOverflow<T>	overflow()
Multi<T>	request(LongConsumer callback)
Multi<T>	subscribed(Consumer<? super org.reactivestreams.Subscription> callback) Deprecated. Use Multi.onSubscribe()
Multi<T>	termination(BiConsumer<Throwable,Boolean> callback) Deprecated. use {Multi.onTermination()}
Multi<T>	termination(Runnable action) Deprecated. use {Multi.onTermination()}

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiOnEvent

public MultiOnEvent(Multi<T> upstream)

Method Detail

subscribed

@Deprecated
public Multi<T> subscribed(Consumer<? super org.reactivestreams.Subscription> callback)

Deprecated. Use Multi.onSubscribe()

Attaches an action executed when the Multi has received a Subscription from upstream. The downstream does not have received the subscription yet. It will be done once the action completes.

This method is not intended to cancel the subscription. It's the responsibility of the subscriber to do so.

Parameters:

callback - the callback, must not be null

Returns:

a new Multi

cancellation

public Multi<T> cancellation(Runnable callback)

Attaches an action executed when a subscription is cancelled. The upstream is not cancelled yet, but will when the callback completes.

Parameters:

callback - the callback, must not be null

Returns:

a new Multi

request

public Multi<T> request(LongConsumer callback)

overflow

public MultiOverflow<T> overflow()

termination

@Deprecated
public Multi<T> termination(BiConsumer<Throwable,Boolean> callback)

Deprecated. use {Multi.onTermination()}

Attaches an action that is executed when the Multi emits a completion or a failure or when the subscriber cancels the subscription.

Parameters:

callback - the consumer receiving the failure if any and a boolean indicating whether the termination is due to a cancellation (the failure parameter would be null in this case). Must not be null.

Returns:

the new Multi

termination

@Deprecated
public Multi<T> termination(Runnable action)

Deprecated. use {Multi.onTermination()}

Attaches an action that is executed when the Multi emits a completion or a failure or when the subscriber cancels the subscription. Unlike termination(BiConsumer), the callback does not receive the failure or cancellation details.

Parameters:

action - the action to execute when the streams completes, fails or the subscription gets cancelled. Must not be null.

Returns:

the new Multi

item

public MultiOnItem<T> item()

Configures the action to execute when the observed Multi emits an item.

Examples:

 
 Multi<T> multi = ...;
 multi.onItem().apply(x -> ...); // Map to another item
 multi.onItem().mapToMulti(x -> ...); // Map to a multi
 
 

Returns:

the object to configure the action to execute when an item is emitted

failure

public MultiOnFailure<T> failure()

Like failure(Predicate) but applied to all failures fired by the upstream multi. It allows configuring the on failure behavior (recovery, retry...).

Returns:

a MultiOnFailure on which you can specify the on failure action

completion

public MultiOnCompletion<T> completion()

Configures the action to execute when the observed Multi emits the completion event.

Returns:

the object to configure the action

failure

public MultiOnFailure<T> failure(Predicate<? super Throwable> predicate)

Configures a predicate filtering the failures on which the behavior (specified with the returned MultiOnFailure) is applied.

For instance, to only when an IOException is fired as failure you can use: multi.onFailure(IOException.class).recoverWithItem("hello")

The fallback value (hello) will only be used if the upstream multi fires a failure of type IOException.

Parameters:

predicate - the predicate, null means applied to all failures

Returns:

a MultiOnFailure configured with the given predicate on which you can specify the on failure action

failure

public MultiOnFailure<T> failure(Class<? extends Throwable> typeOfFailure)

Configures a type of failure filtering the failures on which the behavior (specified with the returned MultiOnFailure) is applied.

For instance, to only when an IOException is fired as failure you can use: multi.onFailure(IOException.class).recoverWithItem("hello")

The fallback value (hello) will only be used if the upstream multi fire a failure of type IOException.*

Parameters:

typeOfFailure - the class of exception, must not be null

Returns:

a MultiOnFailure configured with the given predicate on which you can specify the on failure action

completion

public Multi<T> completion(Runnable callback)