jadex.bridge.service.component.interceptors

Class FutureFunctionality

java.lang.Object

jadex.bridge.service.component.interceptors.FutureFunctionality

Direct Known Subclasses:

ComponentFutureFunctionality

public class FutureFunctionality
extends java.lang.Object

Default future functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger The logger used for notification failure warnings (if any).
protected IResultCommand<java.util.logging.Logger,java.lang.Void>	loggerfetcher
protected boolean	undone

Constructor Summary

Constructors

Constructor and Description
FutureFunctionality(IResultCommand<java.util.logging.Logger,java.lang.Void> loggerfetcher)
FutureFunctionality(java.util.logging.Logger logger)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	addIntermediateResult(java.lang.Object result)
java.lang.Object	addIntermediateResultIfUndone(java.lang.Object result)
static void	connectDelegationFuture(Future target, IFuture source) Connect a delegation future with the source.
static Future<?>	getDelegationFuture(java.lang.Class<?> clazz, FutureFunctionality func)
static <T> Future<T>	getDelegationFuture(IFuture<T> orig, FutureFunctionality func)
protected java.util.logging.Logger	getLogger() Get the logger.
boolean	isUndone() Get the undone.
void	notifyListener(IResultListener<java.lang.Void> notify) Notify the listener.
void	pullIntermediateResult(IResultListener<java.lang.Void> notify) Pull an intermediate result.
void	sendBackwardCommand(java.lang.Object info, IResultListener<java.lang.Void> com) Send a backward command.
void	sendForwardCommand(java.lang.Object info, IResultListener<java.lang.Void> com) Send a foward command.
java.lang.Exception	setException(java.lang.Exception exception)
java.lang.Exception	setExceptionIfUndone(java.lang.Exception exception)
void	setFinished(java.util.Collection<java.lang.Object> results)
void	setFinishedIfUndone(java.util.Collection<java.lang.Object> results)
java.lang.Object	setFirstResult(java.lang.Object result)
java.lang.Object	setResult(java.lang.Object result)
java.lang.Object	setResultIfUndone(java.lang.Object result)
java.lang.Object	setSecondResult(java.lang.Object result)
void	startScheduledNotifications(IResultListener<java.lang.Void> notify) Start the notifications.
void	terminate(java.lang.Exception reason, IResultListener<java.lang.Void> terminate) Terminate the future.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected java.util.logging.Logger logger

The logger used for notification failure warnings (if any).

loggerfetcher

protected IResultCommand<java.util.logging.Logger,java.lang.Void> loggerfetcher

undone

protected boolean undone

Constructor Detail

FutureFunctionality

public FutureFunctionality(java.util.logging.Logger logger)

FutureFunctionality

public FutureFunctionality(IResultCommand<java.util.logging.Logger,java.lang.Void> loggerfetcher)

Method Detail

getLogger

protected java.util.logging.Logger getLogger()

Get the logger.

isUndone

public boolean isUndone()

Get the undone.

Returns:

The undone.

addIntermediateResult

public java.lang.Object addIntermediateResult(java.lang.Object result)

addIntermediateResultIfUndone

public java.lang.Object addIntermediateResultIfUndone(java.lang.Object result)

setFinished

public void setFinished(java.util.Collection<java.lang.Object> results)

setFinishedIfUndone

public void setFinishedIfUndone(java.util.Collection<java.lang.Object> results)

setResult

public java.lang.Object setResult(java.lang.Object result)

setResultIfUndone

public java.lang.Object setResultIfUndone(java.lang.Object result)

setException

public java.lang.Exception setException(java.lang.Exception exception)

setExceptionIfUndone

public java.lang.Exception setExceptionIfUndone(java.lang.Exception exception)

terminate

public void terminate(java.lang.Exception reason,
                      IResultListener<java.lang.Void> terminate)

Terminate the future.

sendForwardCommand

public void sendForwardCommand(java.lang.Object info,
                               IResultListener<java.lang.Void> com)

Send a foward command.

sendBackwardCommand

public void sendBackwardCommand(java.lang.Object info,
                                IResultListener<java.lang.Void> com)

Send a backward command.

notifyListener

public void notifyListener(IResultListener<java.lang.Void> notify)

Notify the listener.

startScheduledNotifications

public void startScheduledNotifications(IResultListener<java.lang.Void> notify)

Start the notifications.

pullIntermediateResult

public void pullIntermediateResult(IResultListener<java.lang.Void> notify)

Pull an intermediate result.

setFirstResult

public java.lang.Object setFirstResult(java.lang.Object result)

setSecondResult

public java.lang.Object setSecondResult(java.lang.Object result)

getDelegationFuture

public static <T> Future<T> getDelegationFuture(IFuture<T> orig,
                                                FutureFunctionality func)

getDelegationFuture

public static Future<?> getDelegationFuture(java.lang.Class<?> clazz,
                                            FutureFunctionality func)

connectDelegationFuture

public static void connectDelegationFuture(Future target,
                                           IFuture source)

Connect a delegation future with the source. Add delegation listener on the source (+ termination handling).