jadex.commons.future

Class CounterResultListener<E>

java.lang.Object

jadex.commons.future.CounterResultListener<E>

All Implemented Interfaces:

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

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

Counter result listener for counting a specified number of resultAvailable calls.

Constructor Summary

Constructors

Constructor and Description
CounterResultListener(int num, boolean ignorefailures, IFunctionalResultListener<Void> countReachedListener) Create a new counter listener.
CounterResultListener(int num, boolean ignorefailures, IFunctionalResultListener<Void> countReachedListener, IFunctionalExceptionListener exListener) Create a new counter listener.
CounterResultListener(int num, boolean ignorefailures, IFunctionalResultListener<Void> countReachedListener, IFunctionalResultListener<E> intermediateResultListener, IFunctionalExceptionListener exListener) Create a new counter listener.
CounterResultListener(int num, boolean ignorefailures, IResultListener<Void> delegate) Create a new counter listener.
CounterResultListener(int num, IFunctionalResultListener<Void> countReachedListener) Create a new counter listener.
CounterResultListener(int num, IFunctionalResultListener<Void> countReachedListener, IFunctionalExceptionListener exListener) Create a new counter listener.
CounterResultListener(int num, IFunctionalResultListener<Void> countReachedListener, IFunctionalResultListener<E> intermediateResultListener, IFunctionalExceptionListener exListener) Create a new counter listener.
CounterResultListener(int num, IResultListener<Void> delegate) Create a new counter listener.

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.
int	getCnt() Get the cnt.
int	getNumber() Get the number.
boolean	intermediateExceptionOccurred(Exception exception) Method that can be overridden to do sth.
void	intermediateResultAvailable(E result) Method that can be overridden to do sth.
boolean	isUndone() Get the undone.
void	resultAvailable(E result) Called when the result is available.
void	resultAvailableIfUndone(E result) Called when the result is available.
void	setNumber(int num) Set the number.

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterResultListener

public CounterResultListener(int num,
                             IFunctionalResultListener<Void> countReachedListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

countReachedListener - Functional listener called when the count is reached.

CounterResultListener

public CounterResultListener(int num,
                             IFunctionalResultListener<Void> countReachedListener,
                             IFunctionalExceptionListener exListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

countReachedListener - Functional listener called when the count is reached.

exListener - The listener that is called on exceptions. Passing null enables default exception logging.

CounterResultListener

public CounterResultListener(int num,
                             IFunctionalResultListener<Void> countReachedListener,
                             IFunctionalResultListener<E> intermediateResultListener,
                             IFunctionalExceptionListener exListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

countReachedListener - Functional listener called when the count is reached.

intermediateResultListener - Functional listener called on intermediate results.

exListener - The listener that is called on exceptions. Passing null enables default exception logging.

CounterResultListener

public CounterResultListener(int num,
                             IResultListener<Void> delegate)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

CounterResultListener

public CounterResultListener(int num,
                             boolean ignorefailures,
                             IFunctionalResultListener<Void> countReachedListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

ignorefailures - Flag whether to ignore failures.

countReachedListener - Functional listener called when the count is reached.

CounterResultListener

public CounterResultListener(int num,
                             boolean ignorefailures,
                             IFunctionalResultListener<Void> countReachedListener,
                             IFunctionalExceptionListener exListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

ignorefailures - Flag whether to ignore failures.

countReachedListener - Functional listener called when the count is reached.

exListener - The listener that is called on exceptions. Passing null enables default exception logging.

CounterResultListener

public CounterResultListener(int num,
                             boolean ignorefailures,
                             IFunctionalResultListener<Void> countReachedListener,
                             IFunctionalResultListener<E> intermediateResultListener,
                             IFunctionalExceptionListener exListener)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

ignorefailures - Flag whether to ignore failures.

countReachedListener - Functional listener called when the count is reached.

intermediateResultListener - Functional listener called on intermediate results, can be null.

exListener - The listener that is called on exceptions. Passing null enables default exception logging.

CounterResultListener

public CounterResultListener(int num,
                             boolean ignorefailures,
                             IResultListener<Void> delegate)

Create a new counter listener.

Parameters:

num - The number of sub callbacks.

Method Detail

resultAvailable

public void resultAvailable(E result)

Called when the result is available.

Specified by:

resultAvailable in interface IFunctionalResultListener<E>

Parameters:

result - The result.

exceptionOccurred

public final void exceptionOccurred(Exception exception)

Called when an exception occurred.

Specified by:

exceptionOccurred in interface IFunctionalExceptionListener

Parameters:

exception - The exception.

intermediateResultAvailable

public void intermediateResultAvailable(E result)

Method that can be overridden to do sth. on each result available call.

intermediateExceptionOccurred

public boolean intermediateExceptionOccurred(Exception exception)

Method that can be overridden to do sth. on each exception that occurs.

Returns:

True, for retry the task (cnt is not increased);

getNumber

public int getNumber()

Get the number.

Returns:

The number.

setNumber

public void setNumber(int num)

Set the number.

Parameters:

num - The number.

getCnt

public int getCnt()

Get the cnt.

Returns:

The cnt.

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.