jadex.commons.future

Class Future<E>

java.lang.Object

jadex.commons.future.Future<E>

All Implemented Interfaces:

IForwardCommandFuture, IFuture<E>

Direct Known Subclasses:

IntermediateFuture, TerminableDelegationFuture, TerminableFuture

public class Future<E>
extends Object
implements IFuture<E>, IForwardCommandFuture

Future that includes mechanisms for callback notification. This allows a caller to decide if a) a blocking call to get() should be used b) a callback shall be invoked

Nested Class Summary

Nested classes/interfaces inherited from interface jadex.commons.future.IForwardCommandFuture

IForwardCommandFuture.Type

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug flag.
static IFuture<?>	EMPTY The empty future.
static boolean	NO_STACK_COMPACTION Disable Stack unfolding for easier debugging.
static ThreadLocal<List<Tuple2<Future<?>,IResultListener<?>>>>	STACK Notification stack for unwinding call stack to topmost future.

Fields inherited from interface jadex.commons.future.IFuture

DONE

Constructor Summary

Constructors

Constructor and Description
Future() Create a new future.
Future(E result) Create a future that is already done.
Future(Exception exception) Create a future that is already failed.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortGet(ISuspendable caller) Abort a blocking get call.
void	addForwardCommand(IFilter<Object> filter, ICommand<Object> command) Add a forward command with a filter.
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.
static <T> IFuture<T>	getEmptyFuture() Get the empty future of some type.
Exception	getException() Get the exception, if any.
boolean	isDone() Test if done, i.e. result is available.
void	removeForwardCommand(ICommand<Object> command) Add a command with a filter.
void	sendForwardCommand(Object command) Send a (forward) command to the listeners.
void	setException(Exception exception) Set the exception.
boolean	setExceptionIfUndone(Exception exception) Set the exception.
void	setResult(E result) Set the result.
boolean	setResultIfUndone(E result) Set the result.

Methods inherited from class java.lang.Object

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

Field Detail

STACK

public static final ThreadLocal<List<Tuple2<Future<?>,IResultListener<?>>>> STACK

Notification stack for unwinding call stack to topmost future.

DEBUG

public static boolean DEBUG

Debug flag.

NO_STACK_COMPACTION

public static boolean NO_STACK_COMPACTION

Disable Stack unfolding for easier debugging.

EMPTY

public static final IFuture<?> EMPTY

The empty future.

Constructor Detail

Future

public Future()

Create a new future.

Future

public Future(E result)

Create a future that is already done.

Parameters:

result - The result, if any.

Future

public Future(Exception exception)

Create a future that is already failed.

Parameters:

exception - The exception.

Method Detail

getEmptyFuture

public static <T> IFuture<T> getEmptyFuture()

Get the empty future of some type.

Returns:

The empty future.

isDone

public boolean isDone()

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

Specified by:

isDone in interface IFuture<E>

Returns:

True, if done.

getException

public Exception getException()

Get the exception, if any.

Specified by:

getException in interface IFuture<E>

Returns:

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

get

public E get()

Get the result - blocking call.

Specified by:

get in interface IFuture<E>

Returns:

The future result.

get

public E get(long timeout)

Get the result - blocking call.

Specified by:

get in interface IFuture<E>

Parameters:

timeout - The timeout in millis.

Returns:

The future result.

get

public E get(ISuspendable caller)

Get the result - blocking call.

Specified by:

get in interface IFuture<E>

Returns:

The future result.

get

public E get(ISuspendable caller,
    long timeout)

Get the result - blocking call.

Specified by:

get in interface IFuture<E>

Parameters:

timeout - The timeout in millis.

Returns:

The future result.

setException

public void setException(Exception exception)

Set the exception. Listener notifications occur on calling thread of this method.

Parameters:

exception - The exception.

setExceptionIfUndone

public boolean setExceptionIfUndone(Exception exception)

Set the exception. Listener notifications occur on calling thread of this method.

Parameters:

exception - The exception.

setResult

public void setResult(E result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

setResultIfUndone

public boolean setResultIfUndone(E result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

Returns:

True if result was set.

abortGet

public void abortGet(ISuspendable caller)

Abort a blocking get call.

addResultListener

public void addResultListener(IResultListener<E> listener)

Add a result listener.

Specified by:

addResultListener in interface IFuture<E>

Parameters:

listsner - The listener.

sendForwardCommand

public void sendForwardCommand(Object command)

Send a (forward) command to the listeners.

Specified by:

sendForwardCommand in interface IForwardCommandFuture

Parameters:

command - The command.

addForwardCommand

public void addForwardCommand(IFilter<Object> filter,
                     ICommand<Object> command)

Add a forward command with a filter. Whenever the future receives an info it will check all registered filters.

removeForwardCommand

public void removeForwardCommand(ICommand<Object> command)

Add a command with a filter. Whenever the future receives an info it will check all registered filters.