net.jodah.failsafe

Class Execution<R>

java.lang.Object

net.jodah.failsafe.ExecutionContext<R>

net.jodah.failsafe.AbstractExecution<R>

net.jodah.failsafe.Execution<R>

Type Parameters:

R - result type

public class Execution<R>
extends AbstractExecution<R>

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

Constructor Summary

Constructors

Constructor and Description
Execution(Policy<R>... policies) Creates a new Execution that will use the policies to handle failures.

Method Summary

Modifier and Type	Method and Description
boolean	canRetryFor(R result) Records an execution and returns true if a retry can be performed for the result, else returns false and marks the execution as complete.
boolean	canRetryFor(R result, Throwable failure) Records an execution and returns true if a retry can be performed for the result or failure, else returns false and marks the execution as complete.
boolean	canRetryOn(Throwable failure) Records an execution and returns true if a retry can be performed for the failure, else returns false and marks the execution as complete.
void	complete() Records and completes the execution successfully.
boolean	complete(R result) Records and attempts to complete the execution with the result.
boolean	recordFailure(Throwable failure) Records a failed execution and returns true if a retry can be performed for the failure, else returns false and completes the execution.

Methods inherited from class net.jodah.failsafe.AbstractExecution

getWaitTime, isComplete

Methods inherited from class net.jodah.failsafe.ExecutionContext

copy, getAttemptCount, getElapsedAttemptTime, getElapsedTime, getExecutionCount, getLastFailure, getLastResult, getLastResult, getStartTime, isCancelled, isFirstAttempt, isRetry, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Execution

@SafeVarargs
public Execution(Policy<R>... policies)

Creates a new Execution that will use the policies to handle failures. Policies are applied in reverse order, with the last policy being applied first.

Throws:

NullPointerException - if policies is null

IllegalArgumentException - if policies is empty

Method Detail

canRetryFor

public boolean canRetryFor(R result)

Records an execution and returns true if a retry can be performed for the result, else returns false and marks the execution as complete.

Throws:

IllegalStateException - if the execution is already complete

canRetryFor

public boolean canRetryFor(R result,
                           Throwable failure)

Records an execution and returns true if a retry can be performed for the result or failure, else returns false and marks the execution as complete.

Throws:

IllegalStateException - if the execution is already complete

canRetryOn

public boolean canRetryOn(Throwable failure)

Records an execution and returns true if a retry can be performed for the failure, else returns false and marks the execution as complete.

Throws:

NullPointerException - if failure is null

IllegalStateException - if the execution is already complete

complete

public void complete()

Records and completes the execution successfully.

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(R result)

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

Throws:

IllegalStateException - if the execution is already complete

recordFailure

public boolean recordFailure(Throwable failure)

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

Alias of canRetryOn(Throwable)

Throws:

NullPointerException - if failure is null

IllegalStateException - if the execution is already complete