Package com.linkedin.alpini.base.concurrency

Class CompletableFutureTask<V>

java.lang.Object

java.util.concurrent.FutureTask<V>

com.linkedin.alpini.base.concurrency.CompletableFutureTask<V>

All Implemented Interfaces:

Runnable, CompletionStage<V>, Future<V>, RunnableFuture<V>

public class CompletableFutureTask<V>
extends FutureTask<V>
implements CompletionStage<V>

Created by acurtis on 4/4/17.

Constructor Summary

Constructors

Constructor	Description
CompletableFutureTask(Runnable runnable, V result)	Creates a CompletableFutureTask that will, upon running, execute the given Runnable, and arrange that get will return the given result on successful completion.
CompletableFutureTask(Callable<V> callable)	Creates a CompletableFutureTask that will, upon running, execute the given Callable.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	acceptEither(CompletionStage<? extends V> other, Consumer<? super V> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends V> other, Consumer<? super V> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends V> other, Consumer<? super V> action, Executor executor)
<U> CompletionStage<U>	applyToEither(CompletionStage<? extends V> other, Function<? super V,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends V> other, Function<? super V,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends V> other, Function<? super V,U> fn, Executor executor)
boolean	cancel(boolean mayInterruptIfRunning)
protected final void	done()	Use the methods provided by the CompletionStage interface to perform actions after the completion of the task.
CompletionStage<V>	exceptionally(Function<Throwable,? extends V> fn)
V	get()
V	get(long timeout, TimeUnit unit)
<U> CompletionStage<U>	handle(BiFunction<? super V,Throwable,? extends U> fn)
<U> CompletionStage<U>	handleAsync(BiFunction<? super V,Throwable,? extends U> fn)
<U> CompletionStage<U>	handleAsync(BiFunction<? super V,Throwable,? extends U> fn, Executor executor)
boolean	isCancelled()
boolean	isDone()
CompletionStage<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionStage<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
protected void	set(V v)
protected void	setException(Throwable t)
CompletionStage<Void>	thenAccept(Consumer<? super V> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super V> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super V> action, Executor executor)
<U> CompletionStage<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action, Executor executor)
<U> CompletionStage<U>	thenApply(Function<? super V,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super V,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super V,? extends U> fn, Executor executor)
<U, W> CompletionStage<W>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends W> fn)
<U, W> CompletionStage<W>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends W> fn)
<U, W> CompletionStage<W>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends W> fn, Executor executor)
<U> CompletionStage<U>	thenCompose(Function<? super V,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn, Executor executor)
CompletionStage<Void>	thenRun(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<V>	toCompletableFuture()
String	toString()	Returns a string identifying this CompletableFutureTask, as well as its completion state.
CompletionStage<V>	whenComplete(BiConsumer<? super V,? super Throwable> action)
CompletionStage<V>	whenCompleteAsync(BiConsumer<? super V,? super Throwable> action)
CompletionStage<V>	whenCompleteAsync(BiConsumer<? super V,? super Throwable> action, Executor executor)

Methods inherited from class java.util.concurrent.FutureTask

run, runAndReset

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

exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync

Constructor Details

CompletableFutureTask

public CompletableFutureTask(Callable<V> callable)

Creates a CompletableFutureTask that will, upon running, execute the given Callable.

Parameters:

callable - the callable task

Throws:

NullPointerException - if the callable is null

CompletableFutureTask

public CompletableFutureTask(Runnable runnable,
 V result)

Creates a CompletableFutureTask that will, upon running, execute the given Runnable, and arrange that get will return the given result on successful completion.

Parameters:

runnable - the runnable task

result - the result to return on successful completion. If you don't need a particular result, consider using constructions of the form: CompletionStage<?> f = new CompletableFutureTask<Void>(runnable, null)

Throws:

NullPointerException - if the runnable is null

Method Details

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

Overrides:

isCancelled in class FutureTask<V>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

Overrides:

isDone in class FutureTask<V>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

Overrides:

cancel in class FutureTask<V>

get

public V get()
      throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<V>

Overrides:

get in class FutureTask<V>

Throws:

InterruptedException

ExecutionException

get

public V get(long timeout,
 @Nonnull
 TimeUnit unit)
      throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<V>

Overrides:

get in class FutureTask<V>

Throws:

InterruptedException

ExecutionException

TimeoutException

done

protected final void done()

Use the methods provided by the CompletionStage interface to perform actions after the completion of the task. This method is final and may not be overridden.

Overrides:

done in class FutureTask<V>

set

protected void set(V v)

Overrides:

set in class FutureTask<V>

setException

protected void setException(Throwable t)

Overrides:

setException in class FutureTask<V>

thenApply

public <U> CompletionStage<U> thenApply(Function<? super V,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<V>

thenApplyAsync

public <U> CompletionStage<U> thenApplyAsync(Function<? super V,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<V>

thenApplyAsync

public <U> CompletionStage<U> thenApplyAsync(Function<? super V,? extends U> fn,
 Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<V>

thenAccept

public CompletionStage<Void> thenAccept(Consumer<? super V> action)

Specified by:

thenAccept in interface CompletionStage<V>

thenAcceptAsync

public CompletionStage<Void> thenAcceptAsync(Consumer<? super V> action)

Specified by:

thenAcceptAsync in interface CompletionStage<V>

thenAcceptAsync

public CompletionStage<Void> thenAcceptAsync(Consumer<? super V> action,
 Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<V>

thenRun

public CompletionStage<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<V>

thenRunAsync

public CompletionStage<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<V>

thenRunAsync

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

Specified by:

thenRunAsync in interface CompletionStage<V>

thenCombine

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

Specified by:

thenCombine in interface CompletionStage<V>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<V>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<V>

thenAcceptBoth

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

Specified by:

thenAcceptBoth in interface CompletionStage<V>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<V>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<V>

runAfterBoth

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

Specified by:

runAfterBoth in interface CompletionStage<V>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<V>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<V>

applyToEither

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

Specified by:

applyToEither in interface CompletionStage<V>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<V>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<V>

acceptEither

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

Specified by:

acceptEither in interface CompletionStage<V>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<V>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<V>

runAfterEither

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

Specified by:

runAfterEither in interface CompletionStage<V>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<V>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<V>

thenCompose

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

Specified by:

thenCompose in interface CompletionStage<V>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<V>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<V>

exceptionally

public CompletionStage<V> exceptionally(Function<Throwable,? extends V> fn)

Specified by:

exceptionally in interface CompletionStage<V>

whenComplete

public CompletionStage<V> whenComplete(BiConsumer<? super V,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<V>

whenCompleteAsync

public CompletionStage<V> whenCompleteAsync(BiConsumer<? super V,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<V>

whenCompleteAsync

public CompletionStage<V> whenCompleteAsync(BiConsumer<? super V,? super Throwable> action,
 Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<V>

handle

public <U> CompletionStage<U> handle(BiFunction<? super V,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<V>

handleAsync

public <U> CompletionStage<U> handleAsync(BiFunction<? super V,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<V>

handleAsync

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

Specified by:

handleAsync in interface CompletionStage<V>

toCompletableFuture

public CompletableFuture<V> toCompletableFuture()

Specified by:

toCompletableFuture in interface CompletionStage<V>

toString

public String toString()

Returns a string identifying this CompletableFutureTask, as well as its completion state. The state, in brackets, contains the String "Completed Normally" or the String "Completed Exceptionally", or the String "Not completed" followed by the number of CompletableFutures dependent upon its completion, if any.

Overrides:

toString in class FutureTask<V>

Returns:

a string identifying this CompletableFutureTask, as well as its state