io.github.avivcarmis.javared.future

Interface RedFuture

All Known Subinterfaces:

RedFutureOf<T>

All Known Implementing Classes:

BaseOpenRedFuture, OpenRedFuture, OpenRedFutureOf

public interface RedFuture

A simple Future like interface, which supports trivial, fully asynchronous, Java 8 callbacks. As opposed to RedFutureOf, this interface represents a future that is not pending value, but only resolved to mark the underlying task complete.

Method Summary

Modifier and Type	Method and Description
RedFuture	addFailureCallback(Callback<Throwable> callback) Attach a callback receiving a throwable to be invoked when the future is failed.
RedFuture	addFailureCallback(Executor executor, Callback<Throwable> callback) Attach a callback receiving a throwable to be invoked when the future is failed.
RedFuture	addFinallyCallback(EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is either successfully resolved, or otherwise failed, in resemblance to java finally block.
RedFuture	addFinallyCallback(Executor executor, EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is either successfully resolved, or otherwise failed, in resemblance to java finally block.
RedFuture	addSuccessCallback(EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is successfully resolved.
RedFuture	addSuccessCallback(Executor executor, EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is successfully resolved.
static <T> RedFutureOf<T>	convert(Future<T> future) Converts the given Future object to a RedFuture see JdkFutureAdapters.listenInPoolThread(Future) for detailed implications
static <T> RedFutureOf<T>	convert(Future<T> future, Executor executor) Converts the given Future object to a RedFuture with given executor see JdkFutureAdapters.listenInPoolThread(Future, Executor) for detailed implications
static RedFuture	failed(Throwable t)
static <T> RedFutureOf<T>	failedOf(Throwable t)
static OpenRedFuture	future()
static <T> OpenRedFutureOf<T>	futureOf()
com.google.common.util.concurrent.ListenableFuture<?>	getListenableFuture()
static RedFutureHub	hub()
boolean	isDone() Test to see whether or not the future is currently completed, either by success or failure.
static RedFuture	resolved()
static <T> RedFutureOf<T>	resolvedOf(T value)
void	waitForCompletion() Tries to blocks the thread until the future is completed.
void	waitForCompletion(long timeout, TimeUnit unit) Tries to blocks the thread for at most the given timeout until the future is completed.

Method Detail

addSuccessCallback

RedFuture addSuccessCallback(EmptyCallback callback)

Attach a no-parameter callback to be invoked when the future is successfully resolved. When a certain thread resolves the future, it will directly invoke the callback. If the future is already resolved, the callback will be directly invoked.

Parameters:

callback - callback to be invoked when the future is successfully resolved

Returns:

this, @see Fluent interface

addSuccessCallback

RedFuture addSuccessCallback(Executor executor,
                             EmptyCallback callback)

Attach a no-parameter callback to be invoked when the future is successfully resolved. When a certain thread resolves the future, it will queue the callback invocation to the given executor. If the future is already resolved, the callback will be immediately queued.

Parameters:

executor - executor to invoke the callback

callback - callback to be invoked when the future is successfully resolved

Returns:

this, @see Fluent interface

addFailureCallback

RedFuture addFailureCallback(Callback<Throwable> callback)

Attach a callback receiving a throwable to be invoked when the future is failed. When a certain thread fails the future, it will directly invoke the callback. If the future has already failed, the callback will be directly invoked.

Parameters:

callback - callback receiving a throwable to be invoked when the future is failed

Returns:

this, @see Fluent interface

addFailureCallback

RedFuture addFailureCallback(Executor executor,
                             Callback<Throwable> callback)

Attach a callback receiving a throwable to be invoked when the future is failed. When a certain thread fails the future, it will queue the callback invocation to the given executor. If the future has already failed, the callback will be immediately queued.

Parameters:

executor - executor to invoke the callback

callback - callback receiving a throwable to be invoked when the future is failed

Returns:

this, @see Fluent interface

addFinallyCallback

RedFuture addFinallyCallback(EmptyCallback callback)

Attach a no-parameter callback to be invoked when the future is either successfully resolved, or otherwise failed, in resemblance to java finally block. When a certain thread resolves the future, it will directly invoke the callback. If the future is already complete, the callback will be directly invoked.

Parameters:

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

addFinallyCallback

RedFuture addFinallyCallback(Executor executor,
                             EmptyCallback callback)

Attach a no-parameter callback to be invoked when the future is either successfully resolved, or otherwise failed, in resemblance to java finally block. When a certain thread fails the future, it will queue the callback invocation to the given executor. If the future is already complete, the callback will be immediately queued.

Parameters:

executor - executor to invoke the callback

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

isDone

boolean isDone()

Test to see whether or not the future is currently completed, either by success or failure. This method is not blocking, nor is it synchronizing different thread calls.

Returns:

true if the future is completed, false otherwise

waitForCompletion

void waitForCompletion()
                throws ExecutionException,
                       InterruptedException

Tries to blocks the thread until the future is completed. If the future is already complete, the method returns immediately.

Throws:

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

See Also:

Future.get()

waitForCompletion

void waitForCompletion(long timeout,
                       TimeUnit unit)
                throws ExecutionException,
                       InterruptedException,
                       TimeoutException

Tries to blocks the thread for at most the given timeout until the future is completed. If the future is already complete, the method returns immediately.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out

See Also:

Future.get(long, TimeUnit)

getListenableFuture

com.google.common.util.concurrent.ListenableFuture<?> getListenableFuture()

Returns:

the underlying Guava ListenableFuture

future

static OpenRedFuture future()

Returns:

a new instance of OpenRedFuture

futureOf

static <T> OpenRedFutureOf<T> futureOf()

Type Parameters:

T - type of the future value

Returns:

a new instance of OpenRedFutureOf

resolved

static RedFuture resolved()

Returns:

a new instance of OpenRedFuture which is already resolved

resolvedOf

static <T> RedFutureOf<T> resolvedOf(T value)

Type Parameters:

T - type of the future value

Parameters:

value - to be resolved with

Returns:

a new instance of OpenRedFutureOf which is already resolved with given value

failed

static RedFuture failed(Throwable t)

Parameters:

t - to fail the future with

Returns:

a new instance of OpenRedFuture which is already failed with given throwable

failedOf

static <T> RedFutureOf<T> failedOf(Throwable t)

Type Parameters:

T - type of the future value

Parameters:

t - to fail the future with

Returns:

a new instance of OpenRedFutureOf which is already failed with given throwable

convert

static <T> RedFutureOf<T> convert(Future<T> future)

Converts the given Future object to a RedFuture see JdkFutureAdapters.listenInPoolThread(Future) for detailed implications

Type Parameters:

T - type of the future value

Parameters:

future - future to convert

Returns:

a RedFuture instance tracking the given Future

convert

static <T> RedFutureOf<T> convert(Future<T> future,
                                  Executor executor)

Converts the given Future object to a RedFuture with given executor see JdkFutureAdapters.listenInPoolThread(Future, Executor) for detailed implications

Type Parameters:

T - type of the future value

Parameters:

future - future to convert

executor - executor to wait to future to complete and then execute callbacks note that if the future is already completed, the callbacks will be executed by the current thread

Returns:

a RedFuture instance tracking the given Future

hub

static RedFutureHub hub()

Returns:

a new instance of RedFutureHub