jadex.commons.future

Class Tuple2Future<E,F>

java.lang.Object

jadex.commons.future.Future<java.util.Collection<E>>

jadex.commons.future.IntermediateFuture<TupleResult>

jadex.commons.future.Tuple2Future<E,F>

All Implemented Interfaces:

IForwardCommandFuture, IFuture<java.util.Collection<TupleResult>>, IIntermediateFuture<TupleResult>, ITuple2Future<E,F>

public class Tuple2Future<E,F>
extends IntermediateFuture<TupleResult>
implements ITuple2Future<E,F>

Implementation of tuple2 future. The future is considered as finished when all tuple elements have been set.

Nested Class Summary

Nested classes/interfaces inherited from interface jadex.commons.future.IForwardCommandFuture

IForwardCommandFuture.Type

Field Summary

Fields inherited from class jadex.commons.future.IntermediateFuture

icallers, indices, intermediate, results, scheduled

Fields inherited from class jadex.commons.future.Future

CALLER_QUEUED, CALLER_RESUMED, CALLER_SUSPENDED, callers, creation, DEBUG, exception, fcommands, first, listener, listeners, NO_STACK_COMPACTION, NONE, result, resultavailable, STACK, undone, UNSET

Fields inherited from interface jadex.commons.future.IIntermediateFuture

DONE

Fields inherited from interface jadex.commons.future.IFuture

FALSE, TRUE

Constructor Summary

Constructors

Constructor and Description
Tuple2Future() Create a future that is already done.
Tuple2Future(E result1, F result2) Create a future that is already done.
Tuple2Future(java.lang.Exception exception) Create a future that is already done (failed).

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.
protected TupleResult	findResult(int idx) Find result in results
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. Will NOT use the suspendable that is supplied as parameter. Get the first result.
protected int	getMax() Get the number of results of the type of future..
F	getSecondResult() Get the second result.
F	getSecondResult(long timeout) Get the second result.
F	getSecondResult(long timeout, boolean realtime) Get the second result.
protected java.lang.Object	getXResult(int idx, long timeout, boolean realtime) Get the x result.
protected void	notifyIntermediateResult(IIntermediateResultListener<TupleResult> listener, TupleResult result) Notify a result listener.
void	setFirstResult(E result) Set the result.
void	setFirstResultIfUndone(E result) Set the result.
void	setSecondResult(F result) Set the result.
void	setSecondResultIfUndone(F result) Set the result.
protected void	setXResult(int idx, java.lang.Object res) Set the xth result.
protected void	setXResultIfUndone(int idx, java.lang.Object res) Set the xth result.

Methods inherited from class jadex.commons.future.IntermediateFuture

addIntermediateResult, addIntermediateResultIfUndone, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addResult, addResultListener, doAddIntermediateResult, doGetNextIntermediateResult, doNotifyListener, doSetFinished, doSetResult, flatMapAsync, getIntermediateResults, getNextIntermediateResult, getNextIntermediateResult, getNextIntermediateResult, hasNextIntermediateResult, mapAsync, mapAsync, notifyListener, resume, resumeIntermediate, scheduleNotification, setFinished, setFinishedIfUndone, startScheduledNotifications

Methods inherited from class jadex.commons.future.Future

abortGet, acceptEither, addForwardCommand, addResultListener, addResultListener, applyToEither, doSetException, get, get, get, get, get, getEmptyFuture, getException, getFuture, hasResultListener, isDone, notifyListenerCommand, removeForwardCommand, sendForwardCommand, setException, setExceptionIfUndone, setResult, setResultIfUndone, thenAccept, thenAccept, thenApply, thenApply, thenCombine, thenCompose, thenCompose

Methods inherited from class java.lang.Object

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

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

Constructor Detail

Tuple2Future

public Tuple2Future()

Create a future that is already done.

Parameters:

result - The result, if any.

Tuple2Future

public Tuple2Future(E result1,
                    F result2)

Create a future that is already done.

Parameters:

result - The result, if any.

Tuple2Future

public Tuple2Future(java.lang.Exception exception)

Create a future that is already done (failed).

Parameters:

exception - The exception.

Method Detail

getFirstResult

public E getFirstResult(ThreadSuspendable sus)

Deprecated. - From 3.0. Use method without suspendable. Will NOT use the suspendable that is supplied as parameter. Get the first result.

Specified by:

getFirstResult in interface ITuple2Future<E,F>

Returns:

The next intermediate result.

Throws:

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

getFirstResult

public E getFirstResult()

Get the first result.

Specified by:

getFirstResult in interface ITuple2Future<E,F>

Returns:

The next intermediate result.

Throws:

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

getSecondResult

public F getSecondResult()

Get the second result.

Specified by:

getSecondResult in interface ITuple2Future<E,F>

Returns:

The next intermediate result.

Throws:

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

getFirstResult

public E getFirstResult(long timeout)

Get the first result.

Specified by:

getFirstResult in interface ITuple2Future<E,F>

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

public F getSecondResult(long timeout)

Get the second result.

Specified by:

getSecondResult in interface ITuple2Future<E,F>

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

public E getFirstResult(long timeout,
                        boolean realtime)

Get the first result.

Specified by:

getFirstResult in interface ITuple2Future<E,F>

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

public F getSecondResult(long timeout,
                         boolean realtime)

Get the second result.

Specified by:

getSecondResult in interface ITuple2Future<E,F>

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.

setFirstResult

public void setFirstResult(E result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

setSecondResult

public void setSecondResult(F result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

setFirstResultIfUndone

public void setFirstResultIfUndone(E result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

addTuple2ResultListener

public 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.

Specified by:

addTuple2ResultListener in interface ITuple2Future<E,F>

Parameters:

firstListener - Listener for the first available result.

secondListener - Listener for the second available result.

addTuple2ResultListener

public 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.

Specified by:

addTuple2ResultListener in interface ITuple2Future<E,F>

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.

setSecondResultIfUndone

public void setSecondResultIfUndone(F result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

setXResult

protected void setXResult(int idx,
                          java.lang.Object res)

Set the xth result.

setXResultIfUndone

protected void setXResultIfUndone(int idx,
                                  java.lang.Object res)

Set the xth result.

getXResult

protected java.lang.Object getXResult(int idx,
                                      long timeout,
                                      boolean realtime)

Get the x result.

Returns:

The next intermediate result.

Throws:

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

findResult

protected TupleResult findResult(int idx)

Find result in results

getMax

protected int getMax()

Get the number of results of the type of future..

notifyIntermediateResult

protected void notifyIntermediateResult(IIntermediateResultListener<TupleResult> listener,
                                        TupleResult result)

Notify a result listener.

Overrides:

notifyIntermediateResult in class IntermediateFuture<TupleResult>

Parameters:

listener - The listener.