Package org.bitcoinj.utils

Class ListenableCompletableFuture<V>

java.lang.Object

java.util.concurrent.CompletableFuture<V>

org.bitcoinj.utils.ListenableCompletableFuture<V>

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<V>, CompletionStage<V>, Future<V>, ListenableCompletionStage<V>

public class ListenableCompletableFuture<V>
extends CompletableFuture<V>
implements ListenableCompletionStage<V>

A CompletableFuture that is also a ListenableFuture for migration from Guava ListenableFuture to CompletableFuture.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
ListenableCompletableFuture()

Method Summary

Modifier and Type	Method	Description
static <T> ListenableCompletableFuture<T>	completedFuture(T value)	Returns a new CompletableFuture that is already completed with the given value.
static <T> ListenableCompletableFuture<T>	failedFuture(Throwable throwable)	Returns a new ListenableCompletableFuture that is already completed exceptionally with the given throwable.
static <T> ListenableCompletableFuture<T>	of(CompletableFuture<T> future)	Converts a generic CompletableFuture to a ListenableCompletableFuture.

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.CompletionStage

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, handle, handleAsync, handleAsync, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface org.bitcoinj.utils.ListenableCompletionStage

addListener

Constructor Details

ListenableCompletableFuture

public ListenableCompletableFuture()

Method Details

completedFuture

public static <T> ListenableCompletableFuture<T> completedFuture(T value)

Returns a new CompletableFuture that is already completed with the given value.

When the migration to CompletableFuture is finished use of this method can be replaced with CompletableFuture.completedFuture(Object).

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

the completed CompletableFuture

failedFuture

public static <T> ListenableCompletableFuture<T> failedFuture(Throwable throwable)

Returns a new ListenableCompletableFuture that is already completed exceptionally with the given throwable.

When the migration to CompletableFuture is finished this can be deprecated and FutureUtils.failedFuture(Throwable) can be used instead.

Type Parameters:

T - the type of the expected value

Parameters:

throwable - the exceptions

Returns:

the completed CompletableFuture

of

public static <T> ListenableCompletableFuture<T> of(CompletableFuture<T> future)

Converts a generic CompletableFuture to a ListenableCompletableFuture. If the passed in future is already a ListenableCompletableFuture no conversion is performed.

When the migration to CompletableFuture is finished usages of this method can simply be removed as the conversion will no longer be required.

Type Parameters:

T - the type of the futures return value

Parameters:

future - A CompletableFuture that may need to be converted

Returns:

A ListenableCompletableFuture