Package io.atomix.utils.concurrent

Class AtomixFuture<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

io.atomix.utils.concurrent.AtomixFuture<T>

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class AtomixFuture<T>
extends CompletableFuture<T>

A CompletableFuture that tracks whether the future or one of its descendants has been blocked on a CompletableFuture.get() or CompletableFuture.join() call.

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
AtomixFuture()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletableFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletableFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> CompletableFuture<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletableFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletableFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
static <T> CompletableFuture<T>	completedFuture(T result)	Returns a new completed Atomix future.
static <T> CompletableFuture<T>	exceptionalFuture(Throwable t)	Returns a new exceptionally completed Atomix future.
T	get()
T	get(long timeout, TimeUnit unit)
<U> CompletableFuture<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> CompletableFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> CompletableFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
T	join()
CompletableFuture<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletableFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletableFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletableFuture<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletableFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletableFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletableFuture<Void>	thenAccept(Consumer<? super T> action)
CompletableFuture<Void>	thenAcceptAsync(Consumer<? super T> action)
CompletableFuture<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> CompletableFuture<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletableFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletableFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> CompletableFuture<U>	thenApply(Function<? super T,? extends U> fn)
<U> CompletableFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> CompletableFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> CompletableFuture<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> CompletableFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> CompletableFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> CompletableFuture<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
CompletableFuture<Void>	thenRun(Runnable action)
CompletableFuture<Void>	thenRunAsync(Runnable action)
CompletableFuture<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
CompletableFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
CompletableFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)
static <T> AtomixFuture<T>	wrap(CompletableFuture<T> future)	Wraps the given future in a new blockable future.

Methods inherited from class java.util.concurrent.CompletableFuture

allOf, anyOf, cancel, complete, completeAsync, completeAsync, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, failedFuture, failedStage, getNow, getNumberOfDependents, isCancelled, isCompletedExceptionally, isDone, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAsync, runAsync, supplyAsync, supplyAsync, toCompletableFuture, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomixFuture

public AtomixFuture()

Method Detail

wrap

public static <T> AtomixFuture<T> wrap(CompletableFuture<T> future)

Wraps the given future in a new blockable future.

Type Parameters:

T - the future value type

Parameters:

future - the future to wrap

Returns:

a new blockable future

completedFuture

public static <T> CompletableFuture<T> completedFuture(T result)

Returns a new completed Atomix future.

Type Parameters:

T - the future result type

Parameters:

result - the future result

Returns:

the completed future

exceptionalFuture

public static <T> CompletableFuture<T> exceptionalFuture(Throwable t)

Returns a new exceptionally completed Atomix future.

Type Parameters:

T - the future result type

Parameters:

t - the future exception

Returns:

the completed future

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Overrides:

get in class CompletableFuture<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Overrides:

get in class CompletableFuture<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

join

public T join()

Overrides:

join in class CompletableFuture<T>

thenApply

public <U> CompletableFuture<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

Overrides:

thenApply in class CompletableFuture<T>

thenApplyAsync

public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class CompletableFuture<T>

thenApplyAsync

public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                               Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class CompletableFuture<T>

thenAccept

public CompletableFuture<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

Overrides:

thenAccept in class CompletableFuture<T>

thenAcceptAsync

public CompletableFuture<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class CompletableFuture<T>

thenAcceptAsync

public CompletableFuture<Void> thenAcceptAsync(Consumer<? super T> action,
                                               Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class CompletableFuture<T>

thenRun

public CompletableFuture<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

Overrides:

thenRun in class CompletableFuture<T>

thenRunAsync

public CompletableFuture<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class CompletableFuture<T>

thenRunAsync

public CompletableFuture<Void> thenRunAsync(Runnable action,
                                            Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class CompletableFuture<T>

thenCombine

public <U,V> CompletableFuture<V> thenCombine(CompletionStage<? extends U> other,
                                                    BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

Overrides:

thenCombine in class CompletableFuture<T>

thenCombineAsync

public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                         BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class CompletableFuture<T>

thenCombineAsync

public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                         BiFunction<? super T,? super U,? extends V> fn,
                                                         Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class CompletableFuture<T>

thenAcceptBoth

public <U> CompletableFuture<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                                  BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

Overrides:

thenAcceptBoth in class CompletableFuture<T>

thenAcceptBothAsync

public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                       BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class CompletableFuture<T>

thenAcceptBothAsync

public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                       BiConsumer<? super T,? super U> action,
                                                       Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class CompletableFuture<T>

runAfterBoth

public CompletableFuture<Void> runAfterBoth(CompletionStage<?> other,
                                            Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

Overrides:

runAfterBoth in class CompletableFuture<T>

runAfterBothAsync

public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                                 Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class CompletableFuture<T>

runAfterBothAsync

public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                                 Runnable action,
                                                 Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class CompletableFuture<T>

applyToEither

public <U> CompletableFuture<U> applyToEither(CompletionStage<? extends T> other,
                                              Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

Overrides:

applyToEither in class CompletableFuture<T>

applyToEitherAsync

public <U> CompletableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                   Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class CompletableFuture<T>

applyToEitherAsync

public <U> CompletableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                   Function<? super T,U> fn,
                                                   Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class CompletableFuture<T>

acceptEither

public CompletableFuture<Void> acceptEither(CompletionStage<? extends T> other,
                                            Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

Overrides:

acceptEither in class CompletableFuture<T>

acceptEitherAsync

public CompletableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                                 Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class CompletableFuture<T>

acceptEitherAsync

public CompletableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                                 Consumer<? super T> action,
                                                 Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class CompletableFuture<T>

runAfterEither

public CompletableFuture<Void> runAfterEither(CompletionStage<?> other,
                                              Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

Overrides:

runAfterEither in class CompletableFuture<T>

runAfterEitherAsync

public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                   Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class CompletableFuture<T>

runAfterEitherAsync

public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                   Runnable action,
                                                   Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class CompletableFuture<T>

thenCompose

public <U> CompletableFuture<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

Overrides:

thenCompose in class CompletableFuture<T>

thenComposeAsync

public <U> CompletableFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class CompletableFuture<T>

thenComposeAsync

public <U> CompletableFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
                                                 Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class CompletableFuture<T>

whenComplete

public CompletableFuture<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

Overrides:

whenComplete in class CompletableFuture<T>

whenCompleteAsync

public CompletableFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Overrides:

whenCompleteAsync in class CompletableFuture<T>

whenCompleteAsync

public CompletableFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
                                              Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Overrides:

whenCompleteAsync in class CompletableFuture<T>

handle

public <U> CompletableFuture<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

Overrides:

handle in class CompletableFuture<T>

handleAsync

public <U> CompletableFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

Overrides:

handleAsync in class CompletableFuture<T>

handleAsync

public <U> CompletableFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
                                            Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>

Overrides:

handleAsync in class CompletableFuture<T>