net.jodah.recurrent

Class AsyncExecution

java.lang.Object

net.jodah.recurrent.ExecutionStats

net.jodah.recurrent.Execution

net.jodah.recurrent.AsyncExecution

public final class AsyncExecution
extends Execution

Tracks asynchronous executions and allows retries to be scheduled according to a RetryPolicy.

Method Summary

Modifier and Type	Method and Description
void	complete() Completes the execution and the associated RecurrentFuture.
boolean	complete(Object result) Attempts to complete the execution and the associated RecurrentFuture with the result.
boolean	complete(Object result, Throwable failure) Attempts to complete the execution and the associated RecurrentFuture with the result and failure.
boolean	retry() Attempts to retry a failed execution.
boolean	retryFor(Object result) Attempts to retry a failed execution.
boolean	retryFor(Object result, Throwable failure) Attempts to retry a failed execution.
boolean	retryOn(Throwable failure) Attempts to retry a failed execution.

Methods inherited from class net.jodah.recurrent.Execution

canRetryFor, canRetryFor, canRetryOn, fail, getLastFailure, getLastResult, getWaitMillis, getWaitNanos, isComplete

Methods inherited from class net.jodah.recurrent.ExecutionStats

getElapsedMillis, getElapsedNanos, getExecutions, getStartMillis, getStartNanos

Methods inherited from class java.lang.Object

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

Method Detail

complete

public void complete()

Completes the execution and the associated RecurrentFuture.

Overrides:

complete in class Execution

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result)

Attempts to complete the execution and the associated RecurrentFuture with the result. Returns true on success, else false if completion failed and should be retried via retry().

Overrides:

complete in class Execution

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result,
                        Throwable failure)

Attempts to complete the execution and the associated RecurrentFuture with the result and failure. Returns true on success, else false if completion failed and should be retried via retry().

Note: the execution may be completed even when the failure is not null, such as when the RetryPolicy does not allow retries for the failure.

Throws:

IllegalStateException - if the execution is already complete

retry

public boolean retry()

Attempts to retry a failed execution. Returns true if the retry can be attempted, else returns returns false and completes the execution and associated RecurrentFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryFor

public boolean retryFor(Object result)

Attempts to retry a failed execution. Returns true if the retry can be attempted for the result, else returns false and completes the execution and associated RecurrentFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryFor

public boolean retryFor(Object result,
                        Throwable failure)

Attempts to retry a failed execution. Returns true if the retry can be attempted for the result and failure, else returns false and completes the execution and associated RecurrentFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryOn

public boolean retryOn(Throwable failure)

Attempts to retry a failed execution. Returns true if the retry can be attempted for the failure, else returns false and completes the execution and associated RecurrentFuture exceptionally.

Throws:

NullPointerException - if failure is null

IllegalStateException - if a retry method has already been called or the execution is already complete