jadex.commons.future

Class IntermediateExceptionDelegationResultListener<E,T>

java.lang.Object

jadex.commons.future.IntermediateExceptionDelegationResultListener<E,T>

All Implemented Interfaces:

IFunctionalExceptionListener, IFunctionalResultListener<java.util.Collection<E>>, IFutureCommandListener, IIntermediateResultListener<E>, IResultListener<java.util.Collection<E>>, IUndoneIntermediateResultListener<E>, IUndoneResultListener<java.util.Collection<E>>

public class IntermediateExceptionDelegationResultListener<E,T>
extends java.lang.Object
implements IIntermediateResultListener<E>, IFutureCommandListener, IUndoneIntermediateResultListener<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected IFunctionalResultListener<java.lang.Void>	finishedListener Custom functional finished listener
protected Future<T>	future The future to which calls are delegated.
protected IFunctionalResultListener<E>	intermediateResultListener Custom functional result listener
protected boolean	undone The undone flag.

Constructor Summary

Constructors

Constructor and Description
IntermediateExceptionDelegationResultListener(Future<T> future) Create a new listener.
IntermediateExceptionDelegationResultListener(Future<T> future, IFunctionalResultListener<E> intermediateResultListener, IFunctionalResultListener<java.lang.Void> finishedListener) Create a new listener.

Method Summary

Modifier and Type	Method and Description
void	commandAvailable(java.lang.Object command) Called when a command is available.
void	customResultAvailable(java.util.Collection<E> result) Called when the result is available.
void	exceptionOccurred(java.lang.Exception exception) Called when an exception occurred.
void	exceptionOccurredIfUndone(java.lang.Exception exception) Called when an exception occurred.
void	finished() Declare that the future is finished.
void	finishedIfUndone() Declare that the future is finished.
void	intermediateResultAvailable(E result) Called when an intermediate result is available.
void	intermediateResultAvailableIfUndone(E result) Called when an intermediate result is available.
boolean	isUndone() Get the undone.
void	resultAvailable(java.util.Collection<E> result) Called when the result is available.
void	resultAvailableIfUndone(java.util.Collection<E> result) Called when the result is available.

Methods inherited from class java.lang.Object

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

Field Detail

future

protected Future<T> future

The future to which calls are delegated.

undone

protected boolean undone

The undone flag.

intermediateResultListener

protected IFunctionalResultListener<E> intermediateResultListener

Custom functional result listener

finishedListener

protected IFunctionalResultListener<java.lang.Void> finishedListener

Custom functional finished listener

Constructor Detail

IntermediateExceptionDelegationResultListener

public IntermediateExceptionDelegationResultListener(Future<T> future,
                                                     IFunctionalResultListener<E> intermediateResultListener,
                                                     IFunctionalResultListener<java.lang.Void> finishedListener)

Create a new listener.

Parameters:

future - The delegation target.

intermediateResultListener - Functional intermediate result Listener. Can be null.

finishedListener - Functional finished listener. Can be null.

IntermediateExceptionDelegationResultListener

public IntermediateExceptionDelegationResultListener(Future<T> future)

Create a new listener.

Method Detail

resultAvailable

public void resultAvailable(java.util.Collection<E> result)

Called when the result is available. This method is only called for non-intermediate futures, i.e. when this method is called it is guaranteed that the intermediateResultAvailable method has not been called.

Specified by:

resultAvailable in interface IFunctionalResultListener<java.util.Collection<E>>

Specified by:

resultAvailable in interface IIntermediateResultListener<E>

Parameters:

result - The final result.

intermediateResultAvailable

public void intermediateResultAvailable(E result)

Called when an intermediate result is available.

Specified by:

intermediateResultAvailable in interface IIntermediateResultListener<E>

Parameters:

result - The result.

finished

public void finished()

Declare that the future is finished. This method is only called for intermediate futures, i.e. when this method is called it is guaranteed that the intermediateResultAvailable method was called for all intermediate results before.

Specified by:

finished in interface IIntermediateResultListener<E>

customResultAvailable

public void customResultAvailable(java.util.Collection<E> result)

Called when the result is available.

Parameters:

result - The result.

exceptionOccurred

public void exceptionOccurred(java.lang.Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurred in interface IFunctionalExceptionListener

Parameters:

exception - The exception.

resultAvailableIfUndone

public void resultAvailableIfUndone(java.util.Collection<E> result)

Called when the result is available.

Specified by:

resultAvailableIfUndone in interface IUndoneResultListener<java.util.Collection<E>>

Parameters:

result - The result.

exceptionOccurredIfUndone

public void exceptionOccurredIfUndone(java.lang.Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurredIfUndone in interface IUndoneResultListener<java.util.Collection<E>>

Parameters:

exception - The exception.

intermediateResultAvailableIfUndone

public void intermediateResultAvailableIfUndone(E result)

Called when an intermediate result is available.

Specified by:

intermediateResultAvailableIfUndone in interface IUndoneIntermediateResultListener<E>

Parameters:

result - The result.

finishedIfUndone

public void finishedIfUndone()

Declare that the future is finished. This method is only called for intermediate futures, i.e. when this method is called it is guaranteed that the intermediateResultAvailable method was called for all intermediate results before.

Specified by:

finishedIfUndone in interface IUndoneIntermediateResultListener<E>

commandAvailable

public void commandAvailable(java.lang.Object command)

Called when a command is available.

Specified by:

commandAvailable in interface IFutureCommandListener

isUndone

public boolean isUndone()

Get the undone.

Returns:

The undone.