io.github.avivcarmis.javared.future

Class RedFutureHub

java.lang.Object

io.github.avivcarmis.javared.future.RedFutureHub

public class RedFutureHub
extends Object

An object to track operations of multiple RedFuture instances.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedFutureHub()

Method Summary

Modifier and Type	Method and Description
RedFutureHub	adoptFuture(RedFuture future) Requests the hub to adopt and track an instance of RedFuture.
RedFutureHub	adoptFutures(Collection<RedFuture> futures) Requests the hub to adopt and track multiple instances of RedFuture.
RedFutureHub	adoptFutures(RedFuture... futures) Requests the hub to adopt and track multiple instances of RedFuture.
RedFutureHub	adoptListenableFuture(com.google.common.util.concurrent.ListenableFuture future) Requests the hub to adopt and track an instance of ListenableFuture.
RedFutureHub	adoptListenableFutures(Collection<com.google.common.util.concurrent.ListenableFuture> futures) Requests the hub to adopt and track multiple instances of ListenableFuture.
RedFutureHub	adoptListenableFutures(com.google.common.util.concurrent.ListenableFuture<?>... futures) Requests the hub to adopt and track multiple instances of ListenableFuture.
OpenRedFuture	provideFuture() Requests the hub to provide and track a single instance of OpenRedFuture.
<T> OpenRedFutureOf<T>	provideFutureOf() Requests the hub to provide and track a single instance of OpenRedFutureOf.
RedFuture	uniteCautiously() Requests the hub to return a single united, cautious RedFuture instance.
RedFuture	uniteOptimistically() Requests the hub to return a single united, optimistic RedFuture instance.
RedFuture	unitePessimistically() Requests the hub to return a single united, pessimistic RedFuture instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedFutureHub

protected RedFutureHub()

Method Detail

provideFuture

public OpenRedFuture provideFuture()

Requests the hub to provide and track a single instance of OpenRedFuture. The instance may be resolved, failed or follow other futures, and will be tracked by the current hub.

Returns:

a new instance of OpenRedFuture

provideFutureOf

public <T> OpenRedFutureOf<T> provideFutureOf()

Requests the hub to provide and track a single instance of OpenRedFutureOf. The instance may be resolved, failed or follow other futures, and will be tracked by the current hub.

Type Parameters:

T - type of the future to return

Returns:

a new instance of OpenRedFutureOf

adoptFuture

public RedFutureHub adoptFuture(RedFuture future)

Requests the hub to adopt and track an instance of RedFuture. This means that the given instance will be tracked by the hub.

Parameters:

future - future to adopt

Returns:

this, @see Fluent interface

adoptFutures

public RedFutureHub adoptFutures(Collection<RedFuture> futures)

Requests the hub to adopt and track multiple instances of RedFuture. This means that the given instances will be tracked by the hub.

Parameters:

futures - a collection of futures to adopt

Returns:

this, @see Fluent interface

adoptFutures

public RedFutureHub adoptFutures(RedFuture... futures)

Requests the hub to adopt and track multiple instances of RedFuture. This means that the given instances will be tracked by the hub.

Parameters:

futures - a collection of futures to adopt

Returns:

this, @see Fluent interface

adoptListenableFuture

public RedFutureHub adoptListenableFuture(com.google.common.util.concurrent.ListenableFuture future)

Requests the hub to adopt and track an instance of ListenableFuture. This means that the given instance will be tracked by the hub.

Parameters:

future - future to adopt

Returns:

this, @see Fluent interface

adoptListenableFutures

public RedFutureHub adoptListenableFutures(Collection<com.google.common.util.concurrent.ListenableFuture> futures)

Requests the hub to adopt and track multiple instances of ListenableFuture. This means that the given instances will be tracked by the hub.

Parameters:

futures - a collection of futures to adopt

Returns:

this, @see Fluent interface

adoptListenableFutures

public RedFutureHub adoptListenableFutures(com.google.common.util.concurrent.ListenableFuture<?>... futures)

Requests the hub to adopt and track multiple instances of ListenableFuture. This means that the given instances will be tracked by the hub.

Parameters:

futures - a collection of futures to adopt

Returns:

this, @see Fluent interface

uniteOptimistically

public RedFuture uniteOptimistically()

Requests the hub to return a single united, optimistic RedFuture instance. Optimistic means that the returned future expects all the hub's tracked futures to resolve successfully, namely, it will be: Successfully resolved if and when all the hub's tracked futures are successfully resolved. Failed if and when the first of the hub's tracked futures is failed.

Returns:

the united future.

unitePessimistically

public RedFuture unitePessimistically()

Requests the hub to return a single united, pessimistic RedFuture instance. Pessimistic means that the returned future expects all the hub's tracked futures to complete at some point, namely, it will be successfully resolved once all the hub's tracked futures are completed. It will not be failed in any case.

Returns:

the united future.

uniteCautiously

public RedFuture uniteCautiously()

Requests the hub to return a single united, cautious RedFuture instance. Cautious means that the returned future expects all the hub's tracked futures to complete at some point, but it still tracks their status. Namely, it will be: Successfully resolved if and when all the hub's tracked futures are successfully resolved. Failed if and when all the hub's tracked futures are completed, but at least one of them has failed, in such a case, the failure callback throwable will be the cause of the first tracked future to fail.

Returns:

the united future.