com.mattunderscore.executors

Interface IRepeatingFuture<V>

Type Parameters:

V - The type of object returned by the task

All Superinterfaces:

Future<V>

All Known Implementing Classes:

RepeatingFuture

public interface IRepeatingFuture<V>
extends Future<V>

A repeating future represents a repeated asynchronous computation.

A computation task has been scheduled to repeat a fixed number of times. This future allows the result of each repetition to be retrieved and the progress thought repetitions is be monitored. The Future.get() methods inherited from Future refer to the most recent execution.

Since:

0.1.0

Author:

Matt Champion

Method Summary

Modifier and Type	Method and Description
int	getCompletedExecutions() Returns the number of times the task has run this allows progress through the repetitions to be monitored.
int	getExpectedExecutions() Get the number of executions that should happen.
V	getResult(int i) Waits if necessary for the ith computation to complete, and then retrieves its result.
V	getResult(int i, long timeout, TimeUnit unit) Waits if necessary for the ith computation to complete, and then retrieves its result.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

getResult

V getResult(int i)
     throws InterruptedException,
            ExecutionException,
            CancellationException,
            IndexOutOfBoundsException

Waits if necessary for the ith computation to complete, and then retrieves its result.

Parameters:

i - The execution of the task to get the result for

Returns:

The result of the execution

Throws:

InterruptedException - Thrown if the thread was interrupted while the waiting

ExecutionException - Thrown if the execution of the task resulted in an exception

CancellationException - Thrown if the task was cancelled before reaching the ith execution

IndexOutOfBoundsException - Thrown if the ith value is greater than the number of executions or it is less than 0.

getResult

V getResult(int i,
            long timeout,
            TimeUnit unit)
     throws InterruptedException,
            ExecutionException,
            CancellationException,
            TimeoutException,
            IndexOutOfBoundsException

Waits if necessary for the ith computation to complete, and then retrieves its result.

Parameters:

i - The execution of the task to get the result for

timeout - The maximum time to wait

unit - The time unit of the timeout argument

Returns:

The result of the execution

Throws:

InterruptedException - Thrown if the thread was interrupted while the waiting

ExecutionException - Thrown if the execution of the task resulted in an exception

CancellationException - Thrown if the task was cancelled before reaching the ith execution

TimeoutException - Thrown if the ith execution does not happen within the timeout period

IndexOutOfBoundsException - Thrown if the ith value is greater than the number of executions or it is less than 0.

getExpectedExecutions

int getExpectedExecutions()

Get the number of executions that should happen.

Returns:

Number of times the task will try to execute.

getCompletedExecutions

int getCompletedExecutions()

Returns the number of times the task has run this allows progress through the repetitions to be monitored.

Returns:

Number of times the task has executed.