Package org.infinispan.commons.util.concurrent

Class CompletableFutures

java.lang.Object

org.infinispan.commons.util.concurrent.CompletableFutures

public final class CompletableFutures
extends Object

Utility methods connecting CompletableFuture futures.

Since:

8.0

Author:

Dan Berindei

Field Summary

Fields

Modifier and Type	Field	Description
static CompletableFuture[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
static CompletionException	asCompletionException(Throwable t)
static boolean	await(CompletableFuture<?> future, long time, TimeUnit unit)	It waits until the CompletableFuture is completed.
static <T> T	await(CompletableFuture<T> future)	Wait for a long time until the CompletableFuture is completed.
static CompletionStage<Boolean>	booleanStage(boolean trueOrFalse)
static <K,V> CompletableFuture<Map<K,V>>	completedEmptyMap()
static <T> CompletableFuture<T>	completedExceptionFuture(Throwable ex)
static CompletableFuture<Boolean>	completedFalse()
static <T> CompletableFuture<T>	completedNull()
static CompletableFuture<Boolean>	completedTrue()
static Throwable	extractException(Throwable t)
static <T> Function<T,T>	identity()
static void	rethrowExceptionIfPresent(Throwable t)
static <T> CompletableFuture<List<T>>	sequence(List<CompletableFuture<T>> futures)
static <T,R> Function<T,R>	toNullFunction()
static <T> Function<T,Boolean>	toTrueFunction()
static boolean	uncheckedAwait(CompletableFuture<?> future, long time, TimeUnit unit)	Same as await(CompletableFuture, long, TimeUnit) but wraps checked exceptions in CacheException
static <T> T	uncheckedAwait(CompletableFuture<T> future)	Same as await(CompletableFuture) but wraps checked exceptions in CacheException

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final CompletableFuture[] EMPTY_ARRAY

Method Detail

completedEmptyMap

public static <K,V> CompletableFuture<Map<K,V>> completedEmptyMap()

completedNull

public static <T> CompletableFuture<T> completedNull()

completedTrue

public static CompletableFuture<Boolean> completedTrue()

completedFalse

public static CompletableFuture<Boolean> completedFalse()

booleanStage

public static CompletionStage<Boolean> booleanStage(boolean trueOrFalse)

sequence

public static <T> CompletableFuture<List<T>> sequence(List<CompletableFuture<T>> futures)

completedExceptionFuture

public static <T> CompletableFuture<T> completedExceptionFuture(Throwable ex)

await

public static boolean await(CompletableFuture<?> future,
                            long time,
                            TimeUnit unit)
                     throws InterruptedException

It waits until the CompletableFuture is completed.

It ignore if the CompletableFuture is completed normally or exceptionally.

Parameters:

future - the CompletableFuture to test.

time - the timeout.

unit - the timeout unit.

Returns:

true if completed, false if timed out.

Throws:

InterruptedException - if interrupted while waiting.

NullPointerException - if future or unit is null.

uncheckedAwait

public static boolean uncheckedAwait(CompletableFuture<?> future,
                                     long time,
                                     TimeUnit unit)

Same as await(CompletableFuture, long, TimeUnit) but wraps checked exceptions in CacheException

Parameters:

future - the CompletableFuture to test.

time - the timeout.

unit - the timeout unit.

Returns:

true if completed, false if timed out.

Throws:

NullPointerException - if future or unit is null.

await

public static <T> T await(CompletableFuture<T> future)
                   throws ExecutionException,
                          InterruptedException

Wait for a long time until the CompletableFuture is completed.

Type Parameters:

T - the return type.

Parameters:

future - the CompletableFuture.

Returns:

the result value.

Throws:

ExecutionException - if the CompletableFuture completed exceptionally.

InterruptedException - if the current thread was interrupted while waiting.

uncheckedAwait

public static <T> T uncheckedAwait(CompletableFuture<T> future)

Same as await(CompletableFuture) but wraps checked exceptions in CacheException

Type Parameters:

T - the return type.

Parameters:

future - the CompletableFuture.

Returns:

the result value.

asCompletionException

public static CompletionException asCompletionException(Throwable t)

rethrowExceptionIfPresent

public static void rethrowExceptionIfPresent(Throwable t)

extractException

public static Throwable extractException(Throwable t)

toNullFunction

public static <T,R> Function<T,R> toNullFunction()

toTrueFunction

public static <T> Function<T,Boolean> toTrueFunction()

identity

public static <T> Function<T,T> identity()