org.apache.flink.runtime.concurrent.impl

Class FlinkCompletableFuture<T>

java.lang.Object

org.apache.flink.runtime.concurrent.impl.FlinkFuture<T>

org.apache.flink.runtime.concurrent.impl.FlinkCompletableFuture<T>

Type Parameters:

T - type of the future's value

All Implemented Interfaces:

CompletableFuture<T>, Future<T>

public class FlinkCompletableFuture<T>
extends FlinkFuture<T>
implements CompletableFuture<T>

Implementation of CompletableFuture which is backed by Promise.

Field Summary

Fields inherited from class org.apache.flink.runtime.concurrent.impl.FlinkFuture

scalaFuture

Constructor Summary

Constructors

Constructor and Description
FlinkCompletableFuture()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Tries to cancel the future's operation.
boolean	complete(T value) Completes the future with the given value.
static <T> FlinkCompletableFuture<T>	completed(T value)
static <T> FlinkCompletableFuture<T>	completedExceptionally(Throwable t)
boolean	completeExceptionally(Throwable t) Completes the future with the given exception.

Methods inherited from class org.apache.flink.runtime.concurrent.impl.FlinkFuture

exceptionally, exceptionallyAsync, get, get, getNow, getScalaFuture, handle, handleAsync, isDone, supplyAsync, thenAccept, thenAcceptAsync, thenApply, thenApplyAsync, thenCombine, thenCombineAsync, thenCompose, thenComposeAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.concurrent.Future

exceptionally, exceptionallyAsync, get, get, getNow, handle, handleAsync, isDone, thenAccept, thenAcceptAsync, thenApply, thenApplyAsync, thenCombine, thenCombineAsync, thenCompose, thenComposeAsync

Constructor Detail

FlinkCompletableFuture

public FlinkCompletableFuture()

Method Detail

complete

public boolean complete(T value)

Description copied from interface: CompletableFuture

Completes the future with the given value. The complete operation only succeeds if the future has not been completed before. Whether it is successful or not is returned by the method.

Specified by:

complete in interface CompletableFuture<T>

Parameters:

value - to complete the future with

Returns:

true if the completion was successful; otherwise false

completeExceptionally

public boolean completeExceptionally(Throwable t)

Description copied from interface: CompletableFuture

Completes the future with the given exception. The complete operation only succeeds if the future has not been completed before. Whether it is successful or not is returned by the method.

Specified by:

completeExceptionally in interface CompletableFuture<T>

Parameters:

t - the exception to complete the future with

Returns:

true if the completion was successful; otherwise false

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Description copied from interface: Future

Tries to cancel the future's operation. Note that not all future operations can be canceled. The result of the cancelling will be returned.

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class FlinkFuture<T>

Parameters:

mayInterruptIfRunning - true iff the future operation may be interrupted

Returns:

true if the cancelling was successful; otherwise false

completed

public static <T> FlinkCompletableFuture<T> completed(T value)

completedExceptionally

public static <T> FlinkCompletableFuture<T> completedExceptionally(Throwable t)