net.jodah.failsafe

Class AsyncExecution

java.lang.Object

net.jodah.failsafe.ExecutionContext

net.jodah.failsafe.AsyncExecution

public final class AsyncExecution
extends ExecutionContext

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 FutureResult.
boolean	complete(Object result) Attempts to complete the execution and the associated FutureResult with the result.
boolean	complete(Object result, Throwable failure) Attempts to complete the execution and the associated FutureResult with the result and failure.
<T extends Throwable> T	getLastFailure() Returns the last failure that was recorded.
<T> T	getLastResult() Returns the last result that was recorded.
Duration	getWaitTime() Returns the time to wait before the next execution attempt.
boolean	isComplete() Returns whether the execution is complete.
boolean	retry() Records an execution and returns true if a retry has been scheduled for else returns returns false and completes the execution and associated FutureResult.
boolean	retryFor(Object result) Records an execution and returns true if a retry has been scheduled for the result, else returns false and marks the execution and associated FutureResult as complete.
boolean	retryFor(Object result, Throwable failure) Records an execution and returns true if a retry has been scheduled for the result or failure, else returns false and marks the execution and associated FutureResult as complete.
boolean	retryOn(Throwable failure) Records an execution and returns true if a retry has been scheduled for the failure, else returns false and marks the execution and associated FutureResult as complete.

Methods inherited from class net.jodah.failsafe.ExecutionContext

getElapsedTime, getExecutions, getStartTime

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

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result)

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

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result,
                        Throwable failure)

Attempts to complete the execution and the associated FutureResult with the result and failure. Returns true on success, else false if completion failed and the execution 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()

Records an execution and returns true if a retry has been scheduled for else returns returns false and completes the execution and associated FutureResult.

Throws:

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

retryFor

public boolean retryFor(Object result)

Records an execution and returns true if a retry has been scheduled for the result, else returns false and marks the execution and associated FutureResult as complete.

Throws:

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

retryFor

public boolean retryFor(Object result,
                        Throwable failure)

Records an execution and returns true if a retry has been scheduled for the result or failure, else returns false and marks the execution and associated FutureResult as complete.

Throws:

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

retryOn

public boolean retryOn(Throwable failure)

Records an execution and returns true if a retry has been scheduled for the failure, else returns false and marks the execution and associated FutureResult as complete.

Throws:

NullPointerException - if failure is null

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

getLastFailure

public <T extends Throwable> T getLastFailure()

Returns the last failure that was recorded.

getLastResult

public <T> T getLastResult()

Returns the last result that was recorded.

getWaitTime

public Duration getWaitTime()

Returns the time to wait before the next execution attempt. Returns 0 if an execution has not yet occurred.

isComplete

public boolean isComplete()

Returns whether the execution is complete.