org.apache.reef.vortex.api

Class AggregateResultSynchronous<TInput,TOutput>

java.lang.Object

org.apache.reef.vortex.api.AggregateResultSynchronous<TInput,TOutput>

public final class AggregateResultSynchronous<TInput,TOutput>
extends Object

The synchronous result of an aggregate, returned by VortexAggregateFuture.get().

Method Summary

Methods

Modifier and Type	Method and Description
List<TInput>	getAggregatedInputs()
TOutput	getAggregateResult()
Optional<Exception>	getException() If an aggregation fails, VortexAggregateException will be thrown, otherwise the Exception that caused the Tasklet to fail will be thrown directly.
boolean	hasNext()

Methods inherited from class java.lang.Object

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

Method Detail

getAggregateResult

public TOutput getAggregateResult()
                           throws VortexAggregateException

Returns:

the output of an aggregation, throws the Exception if a Tasklet or an aggregation fails. If an aggregation fails, VortexAggregateException will be thrown, otherwise the Exception that caused the Tasklet to fail will be thrown directly.

Throws:

VortexAggregateException - the Exception that caused the Tasklet or aggregation failure.

getAggregatedInputs

public List<TInput> getAggregatedInputs()

Returns:

the associated inputs of an aggregation

getException

public Optional<Exception> getException()

If an aggregation fails, VortexAggregateException will be thrown, otherwise the Exception that caused the Tasklet to fail will be thrown directly.

Returns:

the Exception that caused the Tasklet or aggregation failure, if any.

hasNext

public boolean hasNext()

Returns:

true if more results will be available, false otherwise.