Package rocks.xmpp.util.concurrent

Class CompletionStages

java.lang.Object

rocks.xmpp.util.concurrent.CompletionStages

public final class CompletionStages
extends Object

Utility class for creating different kinds of CompletionStage.

Method Summary

Modifier and Type	Method	Description
static <T> CompletionStage<List<T>>	allOf(Collection<? extends CompletionStage<List<T>>> stages)	Returns a completion stage, which is complete when all the completion stages are complete.
static <T> CompletionStage<T>	timeoutAfter(long delay, TimeUnit unit)	Creates a completion stage, which times out after the specified time, i.e. it completes exceptionally with a TimeoutException.
static <T> CompletionStage<T>	timeoutAfter(long delay, TimeUnit unit, Supplier<Throwable> throwableSupplier)	Creates a completion stage, which times out after the specified time, i.e. it completes exceptionally with the supplied exception.
static <T> CompletionStage<T>	withFallback(CompletionStage<T> stage, BiFunction<CompletionStage<T>,Throwable,? extends CompletionStage<T>> fallback)	Creates a new completion stage which uses a fallback stage in case the primary stage completes exceptionally.

Methods inherited from class java.lang.Object

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

Method Detail

withFallback

public static <T> CompletionStage<T> withFallback(CompletionStage<T> stage,
                                                  BiFunction<CompletionStage<T>,Throwable,? extends CompletionStage<T>> fallback)

Creates a new completion stage which uses a fallback stage in case the primary stage completes exceptionally.

Type Parameters:

T - The type.

Parameters:

stage - The primary stage.

fallback - A function, which returns a fallback stage, in case the primary one fails exceptionally.

Returns:

The completion stage with a fallback.

allOf

public static <T> CompletionStage<List<T>> allOf(Collection<? extends CompletionStage<List<T>>> stages)

Returns a completion stage, which is complete when all the completion stages are complete. The lists of each stage are flat mapped into one list, so that the returned stage has one accumulated list.

Type Parameters:

T - The type.

Parameters:

stages - The stages.

Returns:

The future.

timeoutAfter

public static <T> CompletionStage<T> timeoutAfter(long delay,
                                                  TimeUnit unit)

Creates a completion stage, which times out after the specified time, i.e. it completes exceptionally with a TimeoutException.

Type Parameters:

T - The type.

Parameters:

delay - The delay.

unit - The time unit.

Returns:

The stage.

timeoutAfter

public static <T> CompletionStage<T> timeoutAfter(long delay,
                                                  TimeUnit unit,
                                                  Supplier<Throwable> throwableSupplier)

Creates a completion stage, which times out after the specified time, i.e. it completes exceptionally with the supplied exception.

Type Parameters:

T - The type.

Parameters:

delay - The delay.

unit - The time unit.

throwableSupplier - The supplier for an exception which occurs on timeout.

Returns:

The stage.