jadex.commons.future

Class TerminableFuture<E>

java.lang.Object

jadex.commons.future.Future<E>

jadex.commons.future.TerminableFuture<E>

All Implemented Interfaces:

IBackwardCommandFuture, IForwardCommandFuture, IFuture<E>, ITerminableFuture<E>

public class TerminableFuture<E>
extends Future<E>
implements ITerminableFuture<E>

Future that can be terminated from caller side. A termination request leads to setException() being called with a FutureTerminatedException. The future can be supplied with a command that gets executed if terminate is called.

Nested Class Summary

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

IForwardCommandFuture.Type

Field Summary

Fields inherited from class jadex.commons.future.Future

DEBUG, EMPTY, NO_STACK_COMPACTION, STACK

Fields inherited from interface jadex.commons.future.IFuture

DONE

Constructor Summary

Constructors

Constructor and Description
TerminableFuture() Create a new future.
TerminableFuture(ITerminationCommand terminate) Create a future that is already done.

Method Summary

Modifier and Type	Method and Description
void	addBackwardCommand(IFilter<Object> filter, ICommand<Object> command) Add a backward command with a filter.
void	removeBackwardCommand(ICommand<Object> command) Add a command with a filter.
void	sendBackwardCommand(Object info) Send a backward command in direction of the source.
void	setTerminationCommand(ITerminationCommand terminate) Set the termination command.
void	terminate() Terminate the future.
void	terminate(Exception reason) Terminate the future and supply a custom reason.

Methods inherited from class jadex.commons.future.Future

abortGet, addForwardCommand, addResultListener, addResultListener, addResultListener, get, get, get, get, getEmptyFuture, getException, isDone, removeForwardCommand, sendForwardCommand, setException, setExceptionIfUndone, setResult, setResultIfUndone

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.future.IFuture

addResultListener, addResultListener, addResultListener, get, get, get, get, getException, isDone

Constructor Detail

TerminableFuture

public TerminableFuture()

Create a new future.

TerminableFuture

public TerminableFuture(ITerminationCommand terminate)

Create a future that is already done.

Parameters:

result - The result, if any.

Method Detail

terminate

public void terminate()

Terminate the future. The exception will be set to FutureTerminatedException.

Specified by:

terminate in interface ITerminableFuture<E>

terminate

public void terminate(Exception reason)

Terminate the future and supply a custom reason.

Specified by:

terminate in interface ITerminableFuture<E>

sendBackwardCommand

public void sendBackwardCommand(Object info)

Send a backward command in direction of the source.

Specified by:

sendBackwardCommand in interface IBackwardCommandFuture

Parameters:

info - The command info.

addBackwardCommand

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

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

removeBackwardCommand

public void removeBackwardCommand(ICommand<Object> command)

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

setTerminationCommand

public void setTerminationCommand(ITerminationCommand terminate)

Set the termination command.

Parameters:

terminate - The termination command.