Package jadex.commons.future

Class IntermediateExceptionDelegationResultListener<E,T>

java.lang.Object

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

All Implemented Interfaces:

IFunctionalExceptionListener, IFunctionalIntermediateFinishedListener<E>, IFunctionalIntermediateResultCountListener, IFunctionalIntermediateResultListener<E>, IFunctionalResultListener<java.util.Collection<E>>, IFutureCommandResultListener<java.util.Collection<E>>, 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>, IFutureCommandResultListener<java.util.Collection<E>>, IUndoneIntermediateResultListener<E>

Exception delegation listener for intermediate futures.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
IntermediateExceptionDelegationResultListener(Future<T> future)	Create a new listener.
IntermediateExceptionDelegationResultListener(Future<T> future, IFunctionalResultListener<E> irlistener, IFunctionalResultListener<java.lang.Void> flistener, IFunctionalIntermediateResultCountListener clistener)	Create a new listener.

Method Summary

Modifier and Type	Method	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	maxResultCountAvailable(int max)	Declare that the future result count is available.
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.

irlistener

protected IFunctionalResultListener<E> irlistener

Custom functional result listener

flistener

protected IFunctionalResultListener<java.lang.Void> flistener

Custom functional finished listener

clistener

protected IFunctionalIntermediateResultCountListener clistener

Custom functional result count listener.

Constructor Detail

IntermediateExceptionDelegationResultListener

public IntermediateExceptionDelegationResultListener(Future<T> future,
                                                     IFunctionalResultListener<E> irlistener,
                                                     IFunctionalResultListener<java.lang.Void> flistener,
                                                     IFunctionalIntermediateResultCountListener clistener)

Create a new listener.

Parameters:

future - The delegation target.

irlistener - Functional intermediate result Listener. Can be null.

flistener - 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<E>

Parameters:

result - The final result.

intermediateResultAvailable

public void intermediateResultAvailable(E result)

Called when an intermediate result is available.

Specified by:

intermediateResultAvailable in interface IFunctionalIntermediateResultListener<E>

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 IFunctionalIntermediateFinishedListener<E>

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.

maxResultCountAvailable

public void maxResultCountAvailable(int max)

Description copied from interface: IIntermediateResultListener

Declare that the future result count is available. This method is only called for intermediate futures, i.e. when this method is called it is guaranteed that the intermediateResultAvailable method will be called as often as the result count indicates except an exception occurs.

Specified by:

maxResultCountAvailable in interface IFunctionalIntermediateResultCountListener

Specified by:

maxResultCountAvailable in interface IIntermediateResultListener<E>

resultAvailableIfUndone

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

Called when the result is available.

Specified by:

resultAvailableIfUndone in interface IUndoneResultListener<E>

Parameters:

result - The result.

exceptionOccurredIfUndone

public void exceptionOccurredIfUndone(java.lang.Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurredIfUndone in interface IUndoneResultListener<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 IFutureCommandResultListener<E>

isUndone

public boolean isUndone()

Get the undone.

Returns:

The undone.