io.smallrye.mutiny.groups

Class UniOnEvent<T>

java.lang.Object

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

Type Parameters:

T - the type of item emitted by the Uni

public class UniOnEvent<T>
extends Object

Allows configuring the action to execute on each type of events emitted by a Uni or by a UniSubscriber

Constructor Summary

Constructors

Constructor and Description
UniOnEvent(Uni<T> upstream)

Method Summary

Modifier and Type	Method and Description
Uni<T>	cancellation(Runnable runnable) Attaches an action executed when a subscription is cancelled.
UniOnFailure<T>	failure() Like failure(Predicate) but applied to all failures fired by the upstream uni.
UniOnFailure<T>	failure(Class<? extends Throwable> typeOfFailure) Configures a type of failure filtering the failures on which the behavior (specified with the returned UniOnFailure) is applied.
UniOnFailure<T>	failure(Predicate<? super Throwable> predicate) Configures a predicate filtering the failures on which the behavior (specified with the returned UniOnFailure) is applied.
UniOnItem<T>	item() Configures the action to execute when the observed Uni emits the item (potentially null).
Uni<T>	subscribed(Consumer<? super UniSubscription> consumer) Attaches an action executed when the Uni has received a UniSubscription from upstream.
Uni<T>	termination(Functions.TriConsumer<T,Throwable,Boolean> consumer) Attaches an action that is executed when the Uni emits an item or a failure or when the subscriber cancels the subscription.
Uni<T>	termination(Runnable action) Attaches an action that is executed when the Uni emits an item or a failure or when the subscriber cancels the subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniOnEvent

public UniOnEvent(Uni<T> upstream)

Method Detail

subscribed

public Uni<T> subscribed(Consumer<? super UniSubscription> consumer)

Attaches an action executed when the Uni has received a UniSubscription 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:

consumer - the callback, must not be null

Returns:

a new Uni

cancellation

public Uni<T> cancellation(Runnable runnable)

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

Parameters:

runnable - the callback, must not be null

Returns:

a new Uni

termination

public Uni<T> termination(Functions.TriConsumer<T,Throwable,Boolean> consumer)

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

Parameters:

consumer - the consumer receiving the item, the failure and a boolean indicating whether the termination is due to a cancellation (the 2 first parameters would be null in this case). Must not be null If the second parameter (the failure) is not null, the first is necessary null and the third is necessary false as it indicates a termination due to a failure.

Returns:

the new Uni

termination

public Uni<T> termination(Runnable action)

Attaches an action that is executed when the Uni emits an item or a failure or when the subscriber cancels the subscription. Unlike termination(Functions.TriConsumer), the callback does not receive the item, failure or cancellation.

Parameters:

action - the action to run, must not be null

Returns:

the new Uni

item

public UniOnItem<T> item()

Configures the action to execute when the observed Uni emits the item (potentially null).

Examples:

 
 Uni<T> uni = ...;
 uni.onItem().apply(x -> ...); // Map to another item
 uni.onItem().produceUni(x -> ...); // Map to another Uni (flatMap)
 
 

Returns:

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

See Also:

Uni.ifNoItem()

failure

public UniOnFailure<T> failure()

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

Returns:

a UniOnFailure on which you can specify the on failure action

failure

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

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

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

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

Parameters:

predicate - the predicate, null means applied to all failures

Returns:

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

failure

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

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

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

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

Parameters:

typeOfFailure - the class of exception, must not be null

Returns:

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