io.github.avivcarmis.javared.future

Class OpenRedFuture

java.lang.Object

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

io.github.avivcarmis.javared.future.OpenRedFuture

All Implemented Interfaces:

RedFuture

public class OpenRedFuture
extends BaseOpenRedFuture<Void>

An implementation of RedFuture, which represents the settable side of the 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	OpenRedFuture()

Method Summary

Modifier and Type	Method and Description
void	follow(Executor executor, com.google.common.util.concurrent.ListenableFuture<?> listenableFuture) Tells the current open future to follow the given future status.
void	follow(Executor executor, RedFuture future) Tells the current open future to follow the given future status.
void	follow(com.google.common.util.concurrent.ListenableFuture<?> listenableFuture) Tells the current open future to follow the given future status.
void	follow(RedFuture future) Tells the current open future to follow the given future status.
void	resolve() Resolves the future, marking it successfully completed.
void	tryResolve() Resolves the future, marking it successfully completed.

Methods inherited from class io.github.avivcarmis.javared.future.BaseOpenRedFuture

addFailureCallback, addFailureCallback, addFinallyCallback, addFinallyCallback, addSuccessCallback, addSuccessCallback, 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.RedFuture

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

Constructor Detail

OpenRedFuture

protected OpenRedFuture()

Method Detail

resolve

public void resolve()

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)

tryResolve

public void tryResolve()

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.

follow

public void follow(RedFuture 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,
                   RedFuture 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<?> 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<?> 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