io.atlassian.util.concurrent

Class CompletionStages

java.lang.Object

io.atlassian.util.concurrent.CompletionStages

@ParametersAreNonnullByDefault
public final class CompletionStages
extends Object

Helper methods for working with completion stages

Method Summary

Modifier and Type	Method and Description
static <T> CompletionStage<T>	fail(Throwable throwable) Return a completion stage that is already failed with the supplied throwable
static <T> T	unsafeBlockAndGet(CompletionStage<T> completionStage, Function<Throwable,? extends T> onError) Block and retrieve the value from a CompletionStage or handle the associated error.
static <T> T	unsafeBlockAndGet(CompletionStage<T> completionStage, Timeout timeout, Function<Throwable,? extends T> onError) Block and retrieve the value from a CompletionStage or handle the associated error.

Methods inherited from class java.lang.Object

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

Method Detail

fail

public static <T> CompletionStage<T> fail(Throwable throwable)

Return a completion stage that is already failed with the supplied throwable

Type Parameters:

T - The type of the CompletionStage

Parameters:

throwable - The Throwable to completeExceptionally the CompletionStage

Returns:

A CompletionStage which has completed exceptionally with the supplied throwable

unsafeBlockAndGet

public static <T> T unsafeBlockAndGet(CompletionStage<T> completionStage,
                                      Function<Throwable,? extends T> onError)

Block and retrieve the value from a CompletionStage or handle the associated error. In general you should avoid calling this method unless you absolutely have to force a value from the CompletionStage as it will block.

Type Parameters:

T - The type held inside the CompletionState

Parameters:

completionStage - The completionStage that holds the value

onError - Function to be invoked if the forcing of the CompletionStage fails

Returns:

The value in the completion stage if the CompletionStage succeeds or the result of passing the error to onError

unsafeBlockAndGet

public static <T> T unsafeBlockAndGet(CompletionStage<T> completionStage,
                                      Timeout timeout,
                                      Function<Throwable,? extends T> onError)

Block and retrieve the value from a CompletionStage or handle the associated error. In general you should avoid calling this method unless you absolutely have to force a value from the CompletionStage as it will block.

Type Parameters:

T - The type held inside the CompletionState

Parameters:

completionStage - The completionStage that holds the value

timeout - How long to wait when retrieving the future value

onError - Function to be invoked if the forcing of the CompletionStage fails

Returns:

The value in the completion stage if the CompletionStage succeeds or the result of passing the error to onError