jadex.commons.future

Interface ITuple2Future<E,F>

All Superinterfaces:

IFuture<java.util.Collection<TupleResult>>, IIntermediateFuture<TupleResult>

All Known Implementing Classes:

Tuple2Future

public interface ITuple2Future<E,F>
extends IIntermediateFuture<TupleResult>

A tuple future has a defined number of results of possibly different types. The future is considered as finished when all tuple elements have been set.

Field Summary

Fields inherited from interface jadex.commons.future.IIntermediateFuture

DONE

Fields inherited from interface jadex.commons.future.IFuture

FALSE, TRUE

Method Summary

Modifier and Type	Method and Description
void	addTuple2ResultListener(IFunctionalResultListener<E> firstListener, IFunctionalResultListener<F> secondListener) Uses two functional result listeners to create a Tuple2ResultListener and add it.
void	addTuple2ResultListener(IFunctionalResultListener<E> firstListener, IFunctionalResultListener<F> secondListener, IFunctionalExceptionListener exceptionListener) Uses two functional result listeners to create a Tuple2ResultListener and add it.
E	getFirstResult() Get the first result.
E	getFirstResult(long timeout) Get the first result.
E	getFirstResult(long timeout, boolean realtime) Get the first result.
E	getFirstResult(ThreadSuspendable sus) Deprecated. - From 3.0. Use method without suspendable. Get the first result.
F	getSecondResult() Get the second result.
F	getSecondResult(long timeout) Get the second result.
F	getSecondResult(long timeout, boolean realtime) Get the second result.

Methods inherited from interface jadex.commons.future.IIntermediateFuture

addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, flatMapAsync, getIntermediateResults, getNextIntermediateResult, hasNextIntermediateResult, mapAsync, mapAsync

Methods inherited from interface jadex.commons.future.IFuture

acceptEither, addResultListener, addResultListener, addResultListener, applyToEither, get, get, get, get, get, getException, isDone, thenAccept, thenAccept, thenApply, thenApply, thenCombine, thenCompose, thenCompose

Method Detail

getFirstResult

E getFirstResult(ThreadSuspendable sus)

Deprecated. - From 3.0. Use method without suspendable. Get the first result.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getFirstResult

E getFirstResult()

Get the first result.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getSecondResult

F getSecondResult()

Get the second result.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getFirstResult

E getFirstResult(long timeout)

Get the first result.

Parameters:

timeout - The timeout in millis.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getSecondResult

F getSecondResult(long timeout)

Get the second result.

Parameters:

timeout - The timeout in millis.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getFirstResult

E getFirstResult(long timeout,
                 boolean realtime)

Get the first result.

Parameters:

timeout - The timeout in millis.

realtime - Flag if wait should be realtime (in contrast to simulation time).

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getSecondResult

F getSecondResult(long timeout,
                  boolean realtime)

Get the second result.

Parameters:

timeout - The timeout in millis.

realtime - Flag if wait should be realtime (in contrast to simulation time).

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

addTuple2ResultListener

void addTuple2ResultListener(IFunctionalResultListener<E> firstListener,
                             IFunctionalResultListener<F> secondListener)

Uses two functional result listeners to create a Tuple2ResultListener and add it. The first listener is called upon reception of the first result, the second is called for the second result. Exceptions will be logged to console.

Parameters:

firstListener - Listener for the first available result.

secondListener - Listener for the second available result.

addTuple2ResultListener

void addTuple2ResultListener(IFunctionalResultListener<E> firstListener,
                             IFunctionalResultListener<F> secondListener,
                             IFunctionalExceptionListener exceptionListener)

Uses two functional result listeners to create a Tuple2ResultListener and add it. The first listener is called upon reception of the first result, the second is called for the second result. Additionally, a given exception listener is called when exceptions occur.

Parameters:

firstListener - Listener for the first available result.

secondListener - Listener for the second available result.

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