io.github.avivcarmis.javared.future

Class OpenRedFutureOf<T>

java.lang.Object

io.github.avivcarmis.javared.future.BaseOpenRedFuture<T>

io.github.avivcarmis.javared.future.OpenRedFutureOf<T>

Type Parameters:

T - the type of the future value

All Implemented Interfaces:

RedFuture, RedFutureOf<T>, Future<T>

public class OpenRedFutureOf<T>
extends BaseOpenRedFuture<T>
implements RedFutureOf<T>

An implementation of RedFutureOf, which represents the settable side of the typed future. A future of this type may be resolved or failed, as well as attach with callbacks.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenRedFutureOf()

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.
boolean	cancel(boolean mayInterruptIfRunning)
void	follow(Executor executor, com.google.common.util.concurrent.ListenableFuture<T> listenableFuture) Tells the current open future to follow the given future status.
void	follow(Executor executor, RedFutureOf<T> future) Tells the current open future to follow the given future status.
void	follow(com.google.common.util.concurrent.ListenableFuture<T> listenableFuture) Tells the current open future to follow the given future status.
void	follow(RedFutureOf<T> future) Tells the current open future to follow the given future status.
T	get()
T	get(long timeout, TimeUnit unit)
boolean	isCancelled()
void	resolve(T value) Resolves the future, marking it successfully completed.
T	tryGet() Test to see whether or not the future is currently completed, if it is successfully resolved, the resulted value will be returned.
void	tryResolve(T value) Resolves the future, marking it successfully completed.
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 class io.github.avivcarmis.javared.future.BaseOpenRedFuture

fail, fail, getListenableFuture, isDone, resolve, safeCallback, tryFail, waitForCompletion, waitForCompletion

Methods inherited from class java.lang.Object

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

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

getListenableFuture

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

isDone

Constructor Detail

OpenRedFutureOf

protected OpenRedFutureOf()

Method Detail

resolve

public void resolve(T value)

Resolves the future, marking it successfully completed. As result of this method invocation, all registered success and finally callbacks will be invoked. If the future is already completed, a warning will be logged. @see BaseOpenRedFuture.resolve(Object, boolean)

Parameters:

value - the value to resolve the future with

tryResolve

public void tryResolve(T value)

Resolves the future, marking it successfully completed. As result of this method invocation, all registered success and finally callbacks will be invoked. If the future is already completed, this call will be ignored.

Parameters:

value - the value to resolve the future with

follow

public void follow(RedFutureOf<T> future)

Tells the current open future to follow the given future status. When the given future will be resolved or failed, the current future will respectively be directly resolved or failed by the same thread. If the given future is already resolved or failed, the current future will respectively be directly resolved or failed by the current thread. Note that if the future is already completed when trying to follow the given future status, a warning will be logged and the second completion invocation will be ignored. Thus, trying to follow more than one future is illegal.

Parameters:

future - future to follow

follow

public void follow(Executor executor,
                   RedFutureOf<T> future)

Tells the current open future to follow the given future status. When the given future will be resolved or failed, the current future will respectively queued to be resolved or failed with the given executor. If the given future is already resolved or failed, the current future will respectively be queued to be resolved or failed with the given executor. Note that if the future is already completed when trying to follow the given future status, a warning will be logged and the second completion invocation will be ignored. Thus, trying to follow more than one future is illegal.

Parameters:

executor - to execute the completion of this future

future - future to follow

follow

public void follow(com.google.common.util.concurrent.ListenableFuture<T> listenableFuture)

Tells the current open future to follow the given future status. When the given future will be resolved or failed, the current future will respectively be directly resolved or failed by the same thread. If the given future is already resolved or failed, the current future will respectively be directly resolved or failed by the current thread. Note that if the future is already completed when trying to follow the given future status, a warning will be logged and the second completion invocation will be ignored. Thus, trying to follow more than one future is illegal.

Parameters:

listenableFuture - future to follow

follow

public void follow(Executor executor,
                   com.google.common.util.concurrent.ListenableFuture<T> listenableFuture)

Tells the current open future to follow the given future status. When the given future will be resolved or failed, the current future will respectively queued to be resolved or failed with the given executor. If the given future is already resolved or failed, the current future will respectively be queued to be resolved or failed with the given executor. Note that if the future is already completed when trying to follow the given future status, a warning will be logged and the second completion invocation will be ignored. Thus, trying to follow more than one future is illegal.

Parameters:

executor - to execute the completion of this future

listenableFuture - future to follow

addSuccessCallback

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

Description copied from interface: RedFutureOf

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.

Specified by:

addSuccessCallback in interface RedFutureOf<T>

Parameters:

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

Returns:

this, @see Fluent interface

addSuccessCallback

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

Description copied from interface: RedFutureOf

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.

Specified by:

addSuccessCallback in interface RedFutureOf<T>

Parameters:

executor - executor to invoke the callback

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

Returns:

this, @see Fluent interface

tryGet

public T tryGet()

Description copied from interface: RedFutureOf

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

Specified by:

tryGet in interface RedFutureOf<T>

Returns:

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

waitAndGet

public T waitAndGet()
             throws ExecutionException,
                    InterruptedException

Description copied from interface: RedFutureOf

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

Specified by:

waitAndGet in interface RedFutureOf<T>

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

public T waitAndGet(long timeout,
                    TimeUnit unit)
             throws ExecutionException,
                    InterruptedException,
                    TimeoutException

Description copied from interface: RedFutureOf

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.

Specified by:

waitAndGet in interface RedFutureOf<T>

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

public 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

Specified by:

addSuccessCallback in interface RedFutureOf<T>

Overrides:

addSuccessCallback in class BaseOpenRedFuture<T>

Parameters:

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

Returns:

this, @see Fluent interface

addSuccessCallback

public 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

Specified by:

addSuccessCallback in interface RedFutureOf<T>

Overrides:

addSuccessCallback in class BaseOpenRedFuture<T>

Parameters:

executor - executor to invoke the callback

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

Returns:

this, @see Fluent interface

addFailureCallback

public 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

Specified by:

addFailureCallback in interface RedFutureOf<T>

Overrides:

addFailureCallback in class BaseOpenRedFuture<T>

Parameters:

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

Returns:

this, @see Fluent interface

addFailureCallback

public 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

Specified by:

addFailureCallback in interface RedFutureOf<T>

Overrides:

addFailureCallback in class BaseOpenRedFuture<T>

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

public 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

Specified by:

addFinallyCallback in interface RedFutureOf<T>

Overrides:

addFinallyCallback in class BaseOpenRedFuture<T>

Parameters:

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

addFinallyCallback

public 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

Specified by:

addFinallyCallback in interface RedFutureOf<T>

Overrides:

addFinallyCallback in class BaseOpenRedFuture<T>

Parameters:

executor - executor to invoke the callback

callback - callback to be invoked when the future completes

Returns:

this, @see Fluent interface

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException