com.hazelcast.spi.impl

Class AbstractInvocationFuture<V>

java.lang.Object

com.hazelcast.spi.impl.AbstractInvocationFuture<V>

Type Parameters:

V -

All Implemented Interfaces:

ICompletableFuture<V>, InternalCompletableFuture<V>, Future<V>

Direct Known Subclasses:

ClientInvocationFuture

public abstract class AbstractInvocationFuture<V>
extends Object
implements InternalCompletableFuture<V>

Custom implementation of CompletableFuture.

The long term goal is that this whole class can be ripped out and replaced by CompletableFuture from the JDK. So we need to be very careful with adding more functionality to this class because the more we add, the more difficult the replacement will be.

TODO: - thread value protection

Field Summary

Fields

Modifier and Type	Field and Description
protected Executor	defaultExecutor
protected ILogger	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInvocationFuture(Executor defaultExecutor, ILogger logger)

Method Summary

Modifier and Type	Method and Description
void	andThen(ExecutionCallback<V> callback) Registers a callback that will run after the future is completed.
void	andThen(ExecutionCallback<V> callback, Executor executor) Registers a callback that will run with the provided executor after the future is completed.
boolean	cancel(boolean mayInterruptIfRunning)
boolean	complete(Object value) Can be called multiple times, but only the first answer will lead to the future getting triggered.
V	get()
V	get(long timeout, TimeUnit unit)
protected Object	getState()
protected abstract String	invocationToString()
boolean	isCancelled()
boolean	isDone()
V	join() Waits for this future to complete.
protected abstract TimeoutException	newTimeoutException(long timeout, TimeUnit unit)
protected void	onComplete()
protected void	onInterruptDetected()
protected Object	resolve(Object value)
protected abstract V	resolveAndThrowIfException(Object state)
String	toString()
protected Throwable	unwrap(Throwable throwable)

Methods inherited from class java.lang.Object

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

Field Detail

defaultExecutor

protected final Executor defaultExecutor

logger

protected final ILogger logger

Constructor Detail

AbstractInvocationFuture

protected AbstractInvocationFuture(Executor defaultExecutor,
                                   ILogger logger)

Method Detail

getState

protected final Object getState()

isDone

public final boolean isDone()

Specified by:

isDone in interface Future<V>

onInterruptDetected

protected void onInterruptDetected()

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

join

public final V join()

Description copied from interface: InternalCompletableFuture

Waits for this future to complete.

Specified by:

join in interface InternalCompletableFuture<V>

Returns:

the result.

get

public final V get()
            throws InterruptedException,
                   ExecutionException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

get

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

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

TimeoutException

andThen

public void andThen(ExecutionCallback<V> callback)

Description copied from interface: ICompletableFuture

Registers a callback that will run after the future is completed. Please note that there is no ordering guarantee for running multiple callbacks. It is also not guaranteed that the callback will run within the same thread that completes the future.

Specified by:

andThen in interface ICompletableFuture<V>

Parameters:

callback - the callback to execute

andThen

public void andThen(ExecutionCallback<V> callback,
                    Executor executor)

Description copied from interface: ICompletableFuture

Registers a callback that will run with the provided executor after the future is completed. Please note that there is no ordering guarantee for executing multiple callbacks.

Specified by:

andThen in interface ICompletableFuture<V>

Parameters:

callback - the callback to execute

executor - the executor in which the callback will be run

unwrap

protected Throwable unwrap(Throwable throwable)

invocationToString

protected abstract String invocationToString()

resolve

protected Object resolve(Object value)

resolveAndThrowIfException

protected abstract V resolveAndThrowIfException(Object state)
                                         throws ExecutionException,
                                                InterruptedException

Throws:

ExecutionException

InterruptedException

newTimeoutException

protected abstract TimeoutException newTimeoutException(long timeout,
                                                        TimeUnit unit)

complete

public final boolean complete(Object value)

Can be called multiple times, but only the first answer will lead to the future getting triggered. All subsequent complete calls are ignored.

Specified by:

complete in interface InternalCompletableFuture<V>

Parameters:

value - The type of response to offer.

Returns:

true if offered response, either a final response or an internal response, is set/applied, false otherwise. If false is returned, that means offered response is ignored because a final response is already set to this future.

onComplete

protected void onComplete()

toString

public String toString()

Overrides:

toString in class Object