jadex.commons.future

Class CollectionResultListener<E>

java.lang.Object

jadex.commons.future.CollectionResultListener<E>

All Implemented Interfaces:

IFunctionalExceptionListener, IFunctionalResultListener<E>, IResultListener<E>, IUndoneResultListener<E>

public class CollectionResultListener<E>
extends Object
implements IResultListener<E>, IUndoneResultListener<E>

Collection result listener collects a number of results and return a collection.

Constructor Summary

Constructors

Constructor and Description
CollectionResultListener(int num, boolean ignorefailes, IFunctionalResultListener<Collection<E>> resultDelegate, IFunctionalExceptionListener exceptionDelegate) Create a new collection listener.
CollectionResultListener(int num, boolean ignorefailures, IResultListener<Collection<E>> delegate) Create a new collection listener.
CollectionResultListener(int num, IFunctionalResultListener<Collection<E>> resultDelegate) Create a new collection listener that uses default exception handling/logging.
CollectionResultListener(int num, IFunctionalResultListener<Collection<E>> resultDelegate, IFunctionalExceptionListener exceptionDelegate) Create a new collection listener.
CollectionResultListener(int num, IResultListener<Collection<E>> delegate) Create a new collection listener that stops on failures.

Method Summary

Modifier and Type	Method and Description
void	exceptionOccurred(Exception exception) Called when an exception occurred.
void	exceptionOccurredIfUndone(Exception exception) Called when an exception occurred.
boolean	isUndone() Get the undone.
void	resultAvailable(E result) Called when some result is available.
void	resultAvailableIfUndone(E result) Called when the result is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionResultListener

public CollectionResultListener(int num,
                                IFunctionalResultListener<Collection<E>> resultDelegate)

Create a new collection listener that uses default exception handling/logging.

Parameters:

num - The expected number of results.

resultDelegate - The functional delegate result listener.

CollectionResultListener

public CollectionResultListener(int num,
                                IFunctionalResultListener<Collection<E>> resultDelegate,
                                IFunctionalExceptionListener exceptionDelegate)

Create a new collection listener.

Parameters:

num - The expected number of results.

resultDelegate - The functional delegate result listener.

exceptionDelegate - The functional delegate exception listener. Passing null enables default exception logging.

CollectionResultListener

public CollectionResultListener(int num,
                                IResultListener<Collection<E>> delegate)

Create a new collection listener that stops on failures.

Parameters:

num - The expected number of results.

delegate - The delegate result listener.

CollectionResultListener

public CollectionResultListener(int num,
                                boolean ignorefailes,
                                IFunctionalResultListener<Collection<E>> resultDelegate,
                                IFunctionalExceptionListener exceptionDelegate)

Create a new collection listener.

Parameters:

num - The expected number of results.

ignorefailures - When set to true failures will be tolerated and just not be added to the result collection.

resultDelegate - The functional delegate result listener.

exceptionDelegate - The functional delegate exception listener. Passing null enables default exception logging.

CollectionResultListener

public CollectionResultListener(int num,
                                boolean ignorefailures,
                                IResultListener<Collection<E>> delegate)

Create a new collection listener.

Parameters:

num - The expected number of results.

ignorefailures - When set to true failures will be tolerated and just not be added to the result collection.

delegate - The delegate result listener.

Method Detail

resultAvailable

public void resultAvailable(E result)

Called when some result is available.

Specified by:

resultAvailable in interface IFunctionalResultListener<E>

Parameters:

result - The result.

exceptionOccurred

public void exceptionOccurred(Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurred in interface IFunctionalExceptionListener

Parameters:

exception - The exception.

resultAvailableIfUndone

public void resultAvailableIfUndone(E result)

Called when the result is available.

Specified by:

resultAvailableIfUndone in interface IUndoneResultListener<E>

Parameters:

result - The result.

exceptionOccurredIfUndone

public void exceptionOccurredIfUndone(Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurredIfUndone in interface IUndoneResultListener<E>

Parameters:

exception - The exception.

isUndone

public boolean isUndone()

Get the undone.

Returns:

The undone.