io.github.avivcarmis.javared.future

Interface RedFutureOf<T>

Type Parameters:

T - type of the future value

All Superinterfaces:

Future<T>, RedFuture

All Known Implementing Classes:

OpenRedFutureOf

public interface RedFutureOf<T>
extends RedFuture, Future<T>

A simple Future like interface, which supports trivial, fully asynchronous, Java 8 callbacks. As opposed to RedFuture, this interface represents a future that is pending value, and will be resolved with a given value of the future type.

Method Summary

Modifier and Type	Method and Description
RedFutureOf<T>	addFailureCallback(Callback<Throwable> callback) Attach a callback receiving a throwable to be invoked when the future is failed.
RedFutureOf<T>	addFailureCallback(Executor executor, Callback<Throwable> callback) Attach a callback receiving a throwable to be invoked when the future is failed.
RedFutureOf<T>	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.
RedFutureOf<T>	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.
RedFutureOf<T>	addSuccessCallback(Callback<T> callback) Attach a single parameter callback to be invoked when the future is successfully resolved, with the parameter containing the resulted value of the future.
RedFutureOf<T>	addSuccessCallback(EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is successfully resolved.
RedFutureOf<T>	addSuccessCallback(Executor executor, Callback<T> callback) Attach a single parameter callback to be invoked when the future is successfully resolved, with the parameter containing the resulted value of the future.
RedFutureOf<T>	addSuccessCallback(Executor executor, EmptyCallback callback) Attach a no-parameter callback to be invoked when the future is successfully resolved.
com.google.common.util.concurrent.ListenableFuture<T>	getListenableFuture()
T	tryGet() Test to see whether or not the future is currently completed, if it is successfully resolved, the resulted value will be returned.
T	waitAndGet() Tries to blocks the thread until the future is completed.
T	waitAndGet(long timeout, TimeUnit unit) Tries to blocks the thread for at most the given timeout until the future is completed.

Methods inherited from interface io.github.avivcarmis.javared.future.RedFuture

convert, convert, failed, failedOf, future, futureOf, hub, isDone, resolved, resolvedOf, waitForCompletion, waitForCompletion

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

addSuccessCallback

RedFutureOf<T> addSuccessCallback(Callback<T> callback)

Attach a single parameter callback to be invoked when the future is successfully resolved, with the parameter containing the resulted value of the future. 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

RedFutureOf<T> addSuccessCallback(Executor executor,
                                  Callback<T> callback)

Attach a single parameter callback to be invoked when the future is successfully resolved, with the parameter containing the resulted value of the future. 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

tryGet

T tryGet()

Test to see whether or not the future is currently completed, if it is successfully resolved, the resulted value will be returned. This method is not blocking, nor is it synchronizing different thread calls. Note that a return value of null can either indicate that the future is not yet resolved, or that it's has resolved with a null value. To test whether it is resolved or not, one can call the inherited RedFuture.isDone()

Returns:

the resulted value if the future is successfully resolved, null otherwise

waitAndGet

T waitAndGet()
      throws ExecutionException,
             InterruptedException

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

Returns:

the resulted value of the future

Throws:

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

See Also:

Future.get()

waitAndGet

T waitAndGet(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

Returns:

the resulted value of the future

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()

addSuccessCallback

RedFutureOf<T> addSuccessCallback(EmptyCallback callback)

Description copied from interface: RedFuture

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.

Specified by:

addSuccessCallback in interface RedFuture

Parameters:

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

Returns:

this, @see Fluent interface

addSuccessCallback

RedFutureOf<T> addSuccessCallback(Executor executor,
                                  EmptyCallback callback)

Description copied from interface: RedFuture

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.

Specified by:

addSuccessCallback in interface RedFuture

Parameters:

executor - executor to invoke the callback

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

Returns:

this, @see Fluent interface

addFailureCallback

RedFutureOf<T> addFailureCallback(Callback<Throwable> callback)

Description copied from interface: RedFuture

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.

Specified by:

addFailureCallback in interface RedFuture

Parameters:

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

Returns:

this, @see Fluent interface

addFailureCallback

RedFutureOf<T> addFailureCallback(Executor executor,
                                  Callback<Throwable> callback)

Description copied from interface: RedFuture

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.

Specified by:

addFailureCallback in interface RedFuture

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

RedFutureOf<T> addFinallyCallback(EmptyCallback callback)

Description copied from interface: RedFuture

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.

Specified by:

addFinallyCallback in interface RedFuture

Parameters:

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

addFinallyCallback

RedFutureOf<T> addFinallyCallback(Executor executor,
                                  EmptyCallback callback)

Description copied from interface: RedFuture

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.

Specified by:

addFinallyCallback in interface RedFuture

Parameters:

executor - executor to invoke the callback

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

getListenableFuture

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

Specified by:

getListenableFuture in interface RedFuture

Returns:

the underlying Guava ListenableFuture