jadex.commons.future

Class TerminableDelegationFuture<E>

java.lang.Object

jadex.commons.future.Future<E>

jadex.commons.future.TerminableDelegationFuture<E>

All Implemented Interfaces:

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

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

A terminable delegation future can be used when a termination future should be delegated. This kind of future needs to be connected to the termination source (another delegation or a real future). Termination calls are forwarded to the termination source. The future remembers when terminate() was called in unconnected state and forwards the request as soon as the connection is established.

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
TerminableDelegationFuture() Create a new future.
TerminableDelegationFuture(ITerminableFuture<?> src) Create a new future.

Method Summary

Methods

Modifier and Type	Method and Description
void	sendBackwardCommand(Object info) Send a backward command in direction of the source.
void	setTerminationSource(ITerminableFuture<?> src) Set the termination source.
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, 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, get, get, get, get, getException, isDone

Constructor Detail

TerminableDelegationFuture

public TerminableDelegationFuture()

Create a new future.

TerminableDelegationFuture

public TerminableDelegationFuture(ITerminableFuture<?> src)

Create a new future.

Method Detail

setTerminationSource

public void setTerminationSource(ITerminableFuture<?> src)

Set the termination source.

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.