jadex.commons.future

Interface IFuture<E>

All Known Subinterfaces:

IIntermediateFuture<E>, IPullIntermediateFuture<E>, IPullSubscriptionIntermediateFuture<E>, ISubscriptionIntermediateFuture<E>, ITerminableFuture<E>, ITerminableIntermediateFuture<E>, ITuple2Future<E,F>

All Known Implementing Classes:

Future, IntermediateFuture, PullIntermediateDelegationFuture, PullIntermediateFuture, PullSubscriptionIntermediateDelegationFuture, PullSubscriptionIntermediateFuture, SubscriptionIntermediateDelegationFuture, SubscriptionIntermediateFuture, TerminableDelegationFuture, TerminableFuture, TerminableIntermediateDelegationFuture, TerminableIntermediateFuture, Tuple2Future

public interface IFuture<E>

Interface for futures. Similar to Java Future interface but adds a listener notification mechanism.

Field Summary

Fields

Modifier and Type	Field and Description
static IFuture<Void>	DONE A future representing a completed action.

Method Summary

Modifier and Type	Method and Description
void	addResultListener(IFunctionalResultListener<E> listener) Add an functional result listener, which is only called on success.
void	addResultListener(IFunctionalResultListener<E> sucListener, IFunctionalExceptionListener exListener) Add a result listener by combining an OnSuccessListener and an OnExceptionListener.
void	addResultListener(IResultListener<E> listener) Add a result listener.
E	get() Get the result - blocking call.
E	get(ISuspendable caller) Get the result - blocking call.
E	get(ISuspendable caller, long timeout) Get the result - blocking call.
E	get(long timeout) Get the result - blocking call.
Exception	getException() Get the exception, if any.
boolean	isDone() Test if done, i.e.

Field Detail

DONE

static final IFuture<Void> DONE

A future representing a completed action. Can be used as direct return value of methods that do not perform asynchronous operations and do not return a result value.

Method Detail

isDone

boolean isDone()

Test if done, i.e. result is available.

Returns:

True, if done.

getException

Exception getException()

Get the exception, if any.

Returns:

The exception, if any, or null if the future is not yet done or succeeded without exception.

get

E get(ISuspendable caller)

Get the result - blocking call.

Returns:

The future result. deprecated Use get() instead.

get

E get(ISuspendable caller,
      long timeout)

Get the result - blocking call.

Parameters:

timeout - The timeout in millis.

Returns:

The future result. deprecated Use get(timeout) instead.

get

E get()

Get the result - blocking call.

Returns:

The future result.

get

E get(long timeout)

Get the result - blocking call.

Parameters:

timeout - The timeout in millis.

Returns:

The future result.

addResultListener

void addResultListener(IResultListener<E> listener)

Add a result listener.

Parameters:

listener - The listener.

addResultListener

void addResultListener(IFunctionalResultListener<E> listener)

Add an functional result listener, which is only called on success. Exceptions will be handled by DefaultResultListener.

Parameters:

listener - The listener.

addResultListener

void addResultListener(IFunctionalResultListener<E> sucListener,
                       IFunctionalExceptionListener exListener)

Add a result listener by combining an OnSuccessListener and an OnExceptionListener.

Parameters:

sucListener - The listener that is called on success.

exListener - The listener that is called on exceptions. Passing null enables default exception logging.