Package cloud.orbit.concurrent

Class Task<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

cloud.orbit.concurrent.Task<T>

Type Parameters:

T - the type of the returned object.

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class Task<T>
extends CompletableFuture<T>

Task are CompletableFutures were with a few changes.

• complete and completeExceptionally are not publicly accessible.
• few utility methods (thenRun, thenReturn)
• TODO: all callbacks are async by default using the current executor

See Also:

CompletableFuture

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
Task()

Method Summary

Modifier and Type	Method	Description
Task<Void>	acceptEither(CompletionStage<? extends T> completionStage, Consumer<? super T> consumer)
Task<Void>	acceptEitherAsync(CompletionStage<? extends T> completionStage, Consumer<? super T> consumer)
Task<Void>	acceptEitherAsync(CompletionStage<? extends T> completionStage, Consumer<? super T> consumer, Executor executor)
static <F extends CompletableFuture<?>,C extends Collection<F>> Task<Void>	allOf(C cfs)
static Task<Void>	allOf(CompletableFuture<?>... cfs)
static <F extends CompletableFuture<?>> Task<Void>	allOf(Stream<F> cfs)
static <F extends CompletableFuture<?>> Task<Object>	anyOf(Collection<F> cfs)
static Task<Object>	anyOf(CompletableFuture<?>... cfs)
static <F extends CompletableFuture<?>> Task<Object>	anyOf(Stream<F> cfs)
<U> Task<U>	applyToEither(CompletionStage<? extends T> completionStage, Function<? super T,U> function)
<U> Task<U>	applyToEitherAsync(CompletionStage<? extends T> completionStage, Function<? super T,U> function)
<U> Task<U>	applyToEitherAsync(CompletionStage<? extends T> completionStage, Function<? super T,U> function, Executor executor)
boolean	complete(T value)	This completableFuture derived method is not available for Tasks.
boolean	completeExceptionally(Throwable ex)	This completableFuture derived method is not available for Tasks.
static Task<Void>	done()
Task<T>	exceptionally(Function<Throwable,? extends T> fn)
Task<T>	failAfter(long timeout, TimeUnit timeUnit)	Returns a new task that will fail if the original is not completed withing the given timeout.
static <T> Task<T>	from(CompletionStage<T> stage)	Wraps a CompletionStage as a Task or just casts it if it is already a Task.
static <T> Task<T>	fromException(Throwable ex)
static <T> Task<T>	fromFuture(Future<T> future)	Wraps a Future as a Task or just casts it if it is already a Task.
static <T> Task<T>	fromValue(T value)	Creates an already completed task from the given value.
<U> Task<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> Task<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> biFunction)
<U> Task<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> biFunction, Executor executor)
protected boolean	internalComplete(T value)
protected boolean	internalCompleteExceptionally(Throwable ex)
Task<Void>	runAfterBoth(CompletionStage<?> completionStage, Runnable runnable)
Task<Void>	runAfterBothAsync(CompletionStage<?> completionStage, Runnable runnable)
Task<Void>	runAfterBothAsync(CompletionStage<?> completionStage, Runnable runnable, Executor executor)
Task<Void>	runAfterEither(CompletionStage<?> completionStage, Runnable runnable)
Task<Void>	runAfterEitherAsync(CompletionStage<?> completionStage, Runnable runnable)
Task<Void>	runAfterEitherAsync(CompletionStage<?> completionStage, Runnable runnable, Executor executor)
static Task<Void>	runAsync(Runnable runnable)
static Task<Void>	runAsync(Runnable runnable, Executor executor)
static Task<Void>	sleep(long time, TimeUnit timeUnit)	Returns a new task that will fail if the original is not completed withing the given timeout.
static <U> Task<U>	supplyAsync(TaskSupplier<U> supplier)
static <U> Task<U>	supplyAsync(TaskSupplier<U> supplier, Executor executor)
static <U> Task<U>	supplyAsync(Supplier<U> supplier)
static <U> Task<U>	supplyAsync(Supplier<U> supplier, Executor executor)
Task<Void>	thenAccept(Consumer<? super T> action)
Task<Void>	thenAcceptAsync(Consumer<? super T> consumer)
Task<Void>	thenAcceptAsync(Consumer<? super T> consumer, Executor executor)
<U> Task<Void>	thenAcceptBoth(CompletionStage<? extends U> completionStage, BiConsumer<? super T,? super U> biConsumer)
<U> Task<Void>	thenAcceptBothAsync(CompletionStage<? extends U> completionStage, BiConsumer<? super T,? super U> biConsumer)
<U> Task<Void>	thenAcceptBothAsync(CompletionStage<? extends U> completionStage, BiConsumer<? super T,? super U> biConsumer, Executor executor)
<U> Task<U>	thenApply(Function<? super T,? extends U> fn)
<U> Task<U>	thenApplyAsync(Function<? super T,? extends U> function)
<U> Task<U>	thenApplyAsync(Function<? super T,? extends U> function, Executor executor)
<U,V> Task<V>	thenCombine(CompletionStage<? extends U> completionStage, BiFunction<? super T,? super U,? extends V> biFunction)
<U,V> Task<V>	thenCombineAsync(CompletionStage<? extends U> completionStage, BiFunction<? super T,? super U,? extends V> biFunction)
<U,V> Task<V>	thenCombineAsync(CompletionStage<? extends U> completionStage, BiFunction<? super T,? super U,? extends V> biFunction, Executor executor)
<U> Task<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> Task<U>	thenCompose(Supplier<? extends CompletionStage<U>> fn)
<U> Task<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> function)
<U> Task<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> function, Executor executor)
<U> Task<U>	thenReturn(Supplier<U> supplier)	Returns a new Task that is executed when this task completes normally.
Task<Void>	thenRun(Runnable action)
Task<Void>	thenRunAsync(Runnable runnable)
Task<Void>	thenRunAsync(Runnable runnable, Executor executor)
Task<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
Task<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> biConsumer)
Task<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> biConsumer, Executor executor)

Methods inherited from class java.util.concurrent.CompletableFuture

cancel, completeAsync, completeAsync, completedFuture, completedStage, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, toCompletableFuture, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

fromValue

public static <T> Task<T> fromValue(T value)

Creates an already completed task from the given value.

Parameters:

value - the value to be wrapped with a task

fromException

public static <T> Task<T> fromException(Throwable ex)

internalComplete

protected boolean internalComplete(T value)

internalCompleteExceptionally

protected boolean internalCompleteExceptionally(Throwable ex)

complete

public boolean complete(T value)

This completableFuture derived method is not available for Tasks.

Overrides:

complete in class CompletableFuture<T>

completeExceptionally

public boolean completeExceptionally(Throwable ex)

This completableFuture derived method is not available for Tasks.

Overrides:

completeExceptionally in class CompletableFuture<T>

from

public static <T> Task<T> from(CompletionStage<T> stage)

Wraps a CompletionStage as a Task or just casts it if it is already a Task.

Parameters:

stage - the stage to be wrapped or casted to Task

Returns:

stage cast as Task of a new Task that is dependent on the completion of that stage.

fromFuture

public static <T> Task<T> fromFuture(Future<T> future)

Wraps a Future as a Task or just casts it if it is already a Task.

If future implements CompletionStage CompletionStage.handle will be used.

If future is a plain old future, a runnable will executed using a default task pool. This runnable will wait on the future using Future.get(timeout,timeUnit), with a timeout of 5ms. Every time this task times out it will be rescheduled. Starvation of the pool is prevented by the rescheduling behaviour.

Parameters:

future - the future to be wrapped or casted to Task

Returns:

future cast as Task of a new Task that is dependent on the completion of that future.

failAfter

public Task<T> failAfter(long timeout,
                         TimeUnit timeUnit)

Returns a new task that will fail if the original is not completed withing the given timeout. This doesn't modify the original task in any way.

Example:

Task<String> result = aTask.failAfter(60, TimeUnit.SECONDS);

Parameters:

timeout - the time from now

timeUnit - the time unit of the timeout parameter

Returns:

a new task

sleep

public static Task<Void> sleep(long time,
                               TimeUnit timeUnit)

Returns a new task that will fail if the original is not completed withing the given timeout.

Parameters:

time - the time from now

timeUnit - the time unit of the timeout parameter

Returns:

a new task

done

public static Task<Void> done()

thenApply

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

Specified by:

thenApply in interface CompletionStage<T>

Overrides:

thenApply in class CompletableFuture<T>

thenAccept

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

Specified by:

thenAccept in interface CompletionStage<T>

Overrides:

thenAccept in class CompletableFuture<T>

whenComplete

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

Specified by:

whenComplete in interface CompletionStage<T>

Overrides:

whenComplete in class CompletableFuture<T>

thenReturn

public <U> Task<U> thenReturn(Supplier<U> supplier)

Returns a new Task that is executed when this task completes normally. The result of the new Task will be the result of the Supplier passed as parameter.

See the CompletionStage documentation for rules covering exceptional completion.

Type Parameters:

U - the supplier's return type

Parameters:

supplier - the Supplier that will provider the value the returned Task

Returns:

the new Task

thenCompose

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

Specified by:

thenCompose in interface CompletionStage<T>

Overrides:

thenCompose in class CompletableFuture<T>

thenCompose

public <U> Task<U> thenCompose(Supplier<? extends CompletionStage<U>> fn)

handle

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

Specified by:

handle in interface CompletionStage<T>

Overrides:

handle in class CompletableFuture<T>

exceptionally

public Task<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

Overrides:

exceptionally in class CompletableFuture<T>

thenRun

public Task<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

Overrides:

thenRun in class CompletableFuture<T>

acceptEither

public Task<Void> acceptEither(CompletionStage<? extends T> completionStage,
                               Consumer<? super T> consumer)

Specified by:

acceptEither in interface CompletionStage<T>

Overrides:

acceptEither in class CompletableFuture<T>

acceptEitherAsync

public Task<Void> acceptEitherAsync(CompletionStage<? extends T> completionStage,
                                    Consumer<? super T> consumer)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class CompletableFuture<T>

acceptEitherAsync

public Task<Void> acceptEitherAsync(CompletionStage<? extends T> completionStage,
                                    Consumer<? super T> consumer,
                                    Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class CompletableFuture<T>

applyToEither

public <U> Task<U> applyToEither(CompletionStage<? extends T> completionStage,
                                 Function<? super T,U> function)

Specified by:

applyToEither in interface CompletionStage<T>

Overrides:

applyToEither in class CompletableFuture<T>

applyToEitherAsync

public <U> Task<U> applyToEitherAsync(CompletionStage<? extends T> completionStage,
                                      Function<? super T,U> function,
                                      Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class CompletableFuture<T>

applyToEitherAsync

public <U> Task<U> applyToEitherAsync(CompletionStage<? extends T> completionStage,
                                      Function<? super T,U> function)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class CompletableFuture<T>

handleAsync

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

Specified by:

handleAsync in interface CompletionStage<T>

Overrides:

handleAsync in class CompletableFuture<T>

handleAsync

public <U> Task<U> handleAsync(BiFunction<? super T,Throwable,? extends U> biFunction)

Specified by:

handleAsync in interface CompletionStage<T>

Overrides:

handleAsync in class CompletableFuture<T>

runAfterBoth

public Task<Void> runAfterBoth(CompletionStage<?> completionStage,
                               Runnable runnable)

Specified by:

runAfterBoth in interface CompletionStage<T>

Overrides:

runAfterBoth in class CompletableFuture<T>

runAfterBothAsync

public Task<Void> runAfterBothAsync(CompletionStage<?> completionStage,
                                    Runnable runnable)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class CompletableFuture<T>

runAfterBothAsync

public Task<Void> runAfterBothAsync(CompletionStage<?> completionStage,
                                    Runnable runnable,
                                    Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class CompletableFuture<T>

runAfterEither

public Task<Void> runAfterEither(CompletionStage<?> completionStage,
                                 Runnable runnable)

Specified by:

runAfterEither in interface CompletionStage<T>

Overrides:

runAfterEither in class CompletableFuture<T>

runAfterEitherAsync

public Task<Void> runAfterEitherAsync(CompletionStage<?> completionStage,
                                      Runnable runnable)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class CompletableFuture<T>

runAfterEitherAsync

public Task<Void> runAfterEitherAsync(CompletionStage<?> completionStage,
                                      Runnable runnable,
                                      Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class CompletableFuture<T>

runAsync

public static Task<Void> runAsync(Runnable runnable)

runAsync

public static Task<Void> runAsync(Runnable runnable,
                                  Executor executor)

supplyAsync

public static <U> Task<U> supplyAsync(TaskSupplier<U> supplier)

supplyAsync

public static <U> Task<U> supplyAsync(Supplier<U> supplier)

supplyAsync

public static <U> Task<U> supplyAsync(Supplier<U> supplier,
                                      Executor executor)

supplyAsync

public static <U> Task<U> supplyAsync(TaskSupplier<U> supplier,
                                      Executor executor)

thenAcceptAsync

public Task<Void> thenAcceptAsync(Consumer<? super T> consumer,
                                  Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class CompletableFuture<T>

thenAcceptAsync

public Task<Void> thenAcceptAsync(Consumer<? super T> consumer)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class CompletableFuture<T>

thenAcceptBoth

public <U> Task<Void> thenAcceptBoth(CompletionStage<? extends U> completionStage,
                                     BiConsumer<? super T,? super U> biConsumer)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

Overrides:

thenAcceptBoth in class CompletableFuture<T>

thenAcceptBothAsync

public <U> Task<Void> thenAcceptBothAsync(CompletionStage<? extends U> completionStage,
                                          BiConsumer<? super T,? super U> biConsumer,
                                          Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class CompletableFuture<T>

thenAcceptBothAsync

public <U> Task<Void> thenAcceptBothAsync(CompletionStage<? extends U> completionStage,
                                          BiConsumer<? super T,? super U> biConsumer)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class CompletableFuture<T>

thenApplyAsync

public <U> Task<U> thenApplyAsync(Function<? super T,? extends U> function,
                                  Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class CompletableFuture<T>

thenApplyAsync

public <U> Task<U> thenApplyAsync(Function<? super T,? extends U> function)

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class CompletableFuture<T>

thenCombine

public <U,V> Task<V> thenCombine(CompletionStage<? extends U> completionStage,
                                 BiFunction<? super T,? super U,? extends V> biFunction)

Specified by:

thenCombine in interface CompletionStage<T>

Overrides:

thenCombine in class CompletableFuture<T>

thenCombineAsync

public <U,V> Task<V> thenCombineAsync(CompletionStage<? extends U> completionStage,
                                      BiFunction<? super T,? super U,? extends V> biFunction,
                                      Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class CompletableFuture<T>

thenCombineAsync

public <U,V> Task<V> thenCombineAsync(CompletionStage<? extends U> completionStage,
                                      BiFunction<? super T,? super U,? extends V> biFunction)

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class CompletableFuture<T>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class CompletableFuture<T>

thenComposeAsync

public <U> Task<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> function)

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class CompletableFuture<T>

thenRunAsync

public Task<Void> thenRunAsync(Runnable runnable)

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class CompletableFuture<T>

thenRunAsync

public Task<Void> thenRunAsync(Runnable runnable,
                               Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class CompletableFuture<T>

whenCompleteAsync

public Task<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> biConsumer)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Overrides:

whenCompleteAsync in class CompletableFuture<T>

whenCompleteAsync

public Task<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> biConsumer,
                                 Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Overrides:

whenCompleteAsync in class CompletableFuture<T>

allOf

public static Task<Void> allOf(CompletableFuture<?>... cfs)

Throws:

NullPointerException - if the array or any of its elements are null

allOf

public static <F extends CompletableFuture<?>,C extends Collection<F>> Task<Void> allOf(C cfs)

Throws:

NullPointerException - if the collection or any of its elements are null

allOf

public static <F extends CompletableFuture<?>> Task<Void> allOf(Stream<F> cfs)

Throws:

NullPointerException - if the stream or any of its elements are null

anyOf

public static Task<Object> anyOf(CompletableFuture<?>... cfs)

Throws:

NullPointerException - if the array or any of its elements are null

anyOf

public static <F extends CompletableFuture<?>> Task<Object> anyOf(Collection<F> cfs)

Throws:

NullPointerException - if the collection or any of its elements are null

anyOf

public static <F extends CompletableFuture<?>> Task<Object> anyOf(Stream<F> cfs)

Throws:

NullPointerException - if the stream or any of its elements are null