org.apache.flink.runtime.concurrent

Class FutureUtils

java.lang.Object

org.apache.flink.runtime.concurrent.FutureUtils

public class FutureUtils
extends Object

A collection of utilities that expand the usage of Future and CompletableFuture.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FutureUtils.ConjunctFuture<T> A future that is complete once multiple other futures completed.
static class	FutureUtils.RetryException

Constructor Summary

Constructors

Constructor and Description
FutureUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> FutureUtils.ConjunctFuture<Collection<T>>	combineAll(Collection<? extends Future<? extends T>> futures) Creates a future that is complete once multiple other futures completed.
static <T> Future<T>	retry(Callable<Future<T>> operation, int retries, Executor executor) Retry the given operation the given number of times in case of a failure.
static FutureUtils.ConjunctFuture<Void>	waitForAll(Collection<? extends Future<?>> futures) Creates a future that is complete once all of the given futures have completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureUtils

public FutureUtils()

Method Detail

retry

public static <T> Future<T> retry(Callable<Future<T>> operation,
                  int retries,
                  Executor executor)

Retry the given operation the given number of times in case of a failure.

Type Parameters:

T - type of the result

Parameters:

operation - to executed

retries - if the operation failed

executor - to use to run the futures

Returns:

Future containing either the result of the operation or a FutureUtils.RetryException

combineAll

public static <T> FutureUtils.ConjunctFuture<Collection<T>> combineAll(Collection<? extends Future<? extends T>> futures)

Creates a future that is complete once multiple other futures completed. The future fails (completes exceptionally) once one of the futures in the conjunction fails. Upon successful completion, the future returns the collection of the futures' results.

The ConjunctFuture gives access to how many Futures in the conjunction have already completed successfully, via FutureUtils.ConjunctFuture.getNumFuturesCompleted().

Parameters:

futures - The futures that make up the conjunction. No null entries are allowed.

Returns:

The ConjunctFuture that completes once all given futures are complete (or one fails).

waitForAll

public static FutureUtils.ConjunctFuture<Void> waitForAll(Collection<? extends Future<?>> futures)

Creates a future that is complete once all of the given futures have completed. The future fails (completes exceptionally) once one of the given futures fails.

The ConjunctFuture gives access to how many Futures have already completed successfully, via FutureUtils.ConjunctFuture.getNumFuturesCompleted().

Parameters:

futures - The futures to wait on. No null entries are allowed.

Returns:

The WaitingFuture that completes once all given futures are complete (or one fails).