io.github.avivcarmis.javared.future

Class BaseOpenRedFuture<T>

java.lang.Object

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

All Implemented Interfaces:

RedFuture

Direct Known Subclasses:

OpenRedFuture, OpenRedFutureOf

public abstract class BaseOpenRedFuture<T>
extends Object
implements RedFuture

An abstract class to implement common functionality of both RedFuture and RedFutureOf

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseOpenRedFuture()

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.
void	fail(Throwable throwable) Fails the future with given throwable.
protected boolean	fail(Throwable throwable, boolean require) Failing the underlying SettableFuture with given cause, either logging or not logging warning in case the future is already complete, according to require parameter.
com.google.common.util.concurrent.ListenableFuture<T>	getListenableFuture()
boolean	isDone() Test to see whether or not the future is currently completed, either by success or failure.
protected boolean	resolve(T value, boolean require) Resolving the underlying SettableFuture with given value, either logging or not logging warning in case the future is already complete, according to require parameter.
protected <K> com.google.common.util.concurrent.FutureCallback<K>	safeCallback(Callback<K> onSuccess, Callback<Throwable> onFailure) Generates a guava FutureCallback to attach to a ListenableFuture with given success and failure callbacks.
void	tryFail(Throwable throwable) Fails the future with given throwable.
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.

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.RedFuture

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

Constructor Detail

BaseOpenRedFuture

protected BaseOpenRedFuture()

Method Detail

fail

public void fail(Throwable throwable)

Fails the future with given throwable. As result of this method invocation, all registered failure and finally callbacks will be invoked. If the future is already completed, a warning will be logged. @see fail(Throwable, boolean)

Parameters:

throwable - cause of the failure

tryFail

public void tryFail(Throwable throwable)

Fails the future with given throwable. As result of this method invocation, all registered failure and finally callbacks will be invoked. If the future is already completed, this call will be ignored.

Parameters:

throwable - cause of the failure

addSuccessCallback

public RedFuture 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

public RedFuture 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

public RedFuture 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

public RedFuture 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

public RedFuture 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

public RedFuture 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

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

Specified by:

getListenableFuture in interface RedFuture

Returns:

the underlying Guava ListenableFuture

waitForCompletion

public void waitForCompletion()
                       throws ExecutionException,
                              InterruptedException

Description copied from interface: RedFuture

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

Specified by:

waitForCompletion in interface RedFuture

Throws:

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

See Also:

Future.get()

waitForCompletion

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

Description copied from interface: RedFuture

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:

waitForCompletion in interface RedFuture

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)

isDone

public boolean isDone()

Description copied from interface: RedFuture

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.

Specified by:

isDone in interface RedFuture

Returns:

true if the future is completed, false otherwise

resolve

protected boolean resolve(T value,
                          boolean require)

Resolving the underlying SettableFuture with given value, either logging or not logging warning in case the future is already complete, according to require parameter.

Parameters:

value - value to resolve the future with

require - whether or not to log warning in case the future is already complete

Returns:

true if successfully resolved, false if future is already complete

fail

protected boolean fail(Throwable throwable,
                       boolean require)

Failing the underlying SettableFuture with given cause, either logging or not logging warning in case the future is already complete, according to require parameter.

Parameters:

throwable - cause to fail the future with

require - whether or not to log warning in case the future is already complete

Returns:

true if successfully failed, false if future is already complete

safeCallback

protected <K> com.google.common.util.concurrent.FutureCallback<K> safeCallback(Callback<K> onSuccess,
                                                                               Callback<Throwable> onFailure)

Generates a guava FutureCallback to attach to a ListenableFuture with given success and failure callbacks. Wraps the invocations such that if an uncaught runtime exception is thrown from a callback invocation, a warning is logged. Such a case must be seriously considered in an asynchronous system, as it can cause the system to freeze if some pending propagation has not reached before the exception was thrown.

Type Parameters:

K - type of the returned FutureCallback

Parameters:

onSuccess - callback on be invoked on success, or null to skip success event.

onFailure - callback on be invoked on failure, or null to skip failure event.

Returns:

a guava FutureCallback to attach to a ListenableFuture