net.jodah.recurrent

Class Execution

java.lang.Object

net.jodah.recurrent.ExecutionStats

net.jodah.recurrent.Execution

Direct Known Subclasses:

AsyncExecution

public class Execution
extends ExecutionStats

Tracks executions and determines when an execution can be performed for a RetryPolicy.

Constructor Summary

Constructors

Constructor and Description
Execution(RetryPolicy retryPolicy) Creates a new Execution for the retryPolicy.

Method Summary

Modifier and Type	Method and Description
boolean	canRetryFor(Object result) Returns true if a retry can be performed for the result, else returns false and completes the execution.
boolean	canRetryFor(Object result, Throwable failure) Returns true if a retry can be performed for the result or failure, else returns false and completes the execution.
boolean	canRetryOn(Throwable failure) Returns true if a retry can be performed for the failure, else returns false and completes the execution.
void	complete() Completes the execution.
boolean	complete(Object result) Attempts to complete the execution with the result.
boolean	fail(Throwable failure) Fails the execution attempt and returns true if a retry can be performed for the failure, else returns false and completes the execution.
<T extends Throwable> T	getLastFailure() Returns the last failure that was recorded.
<T> T	getLastResult() Returns the last result that was recorded.
long	getWaitMillis() Returns the wait time in milliseconds.
long	getWaitNanos() Returns the wait time in nanoseconds.
boolean	isComplete() Returns whether the execution is complete.

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

Constructor Detail

Execution

public Execution(RetryPolicy retryPolicy)

Creates a new Execution for the retryPolicy.

Throws:

NullPointerException - if retryPolicy is null

Method Detail

canRetryFor

public boolean canRetryFor(Object result)

Returns true if a retry can be performed for the result, else returns false and completes the execution.

Throws:

IllegalStateException - if the execution is already complete

canRetryFor

public boolean canRetryFor(Object result,
                           Throwable failure)

Returns true if a retry can be performed for the result or failure, else returns false and completes the execution.

Throws:

IllegalStateException - if the execution is already complete

canRetryOn

public boolean canRetryOn(Throwable failure)

Returns true if a retry can be performed for the failure, else returns false and completes the execution.

Throws:

NullPointerException - if failure is null

IllegalStateException - if the execution is already complete

complete

public void complete()

Completes the execution.

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result)

Attempts to complete the execution with the result. Returns true on success, else false if completion failed and should be retried.

Throws:

IllegalStateException - if the execution is already complete

getLastFailure

public <T extends Throwable> T getLastFailure()

Returns the last failure that was recorded.

See Also:

fail(Throwable)

getLastResult

public <T> T getLastResult()

Returns the last result that was recorded.

See Also:

complete(), complete(Object)

getWaitMillis

public long getWaitMillis()

Returns the wait time in milliseconds.

getWaitNanos

public long getWaitNanos()

Returns the wait time in nanoseconds.

isComplete

public boolean isComplete()

Returns whether the execution is complete.

See Also:

complete(), complete(Object), fail(Throwable)

fail

public boolean fail(Throwable failure)

Fails the execution attempt and returns true if a retry can be performed for the failure, else returns false and completes the execution.

Alias of canRetryOn(Throwable)

Throws:

IllegalStateException - if the execution is already complete