net.jodah.failsafe

Class DelayablePolicy<S,R>

java.lang.Object

net.jodah.failsafe.PolicyListeners<S,R>

net.jodah.failsafe.FailurePolicy<S,R>

net.jodah.failsafe.DelayablePolicy<S,R>

Type Parameters:

S - self type

R - result type

All Implemented Interfaces:

Policy<R>

Direct Known Subclasses:

CircuitBreaker, RetryPolicy

public abstract class DelayablePolicy<S,R>
extends FailurePolicy<S,R>

A policy that can be delayed between executions.

Constructor Summary

Constructors

Constructor and Description
DelayablePolicy()

Method Summary

Modifier and Type	Method and Description
protected Duration	computeDelay(ExecutionContext context) Returns a computed delay for the result and context else null if no delay function is configured or the computed delay is invalid.
DelayFunction<R,? extends Throwable>	getDelayFn() Returns the function that determines the next delay before allowing another execution.
S	withDelay(DelayFunction<R,? extends Throwable> delayFunction) Sets the delayFunction that computes the next delay before allowing another execution.
<F extends Throwable> S	withDelayOn(DelayFunction<R,F> delayFunction, Class<F> failure) Sets the delayFunction that computes the next delay before allowing another execution.
S	withDelayWhen(DelayFunction<R,? extends Throwable> delayFunction, R result) Sets the delayFunction that computes the next delay before allowing another execution.

Methods inherited from class net.jodah.failsafe.FailurePolicy

handle, handle, handle, handleIf, handleIf, handleResult, handleResultIf, isFailure

Methods inherited from class net.jodah.failsafe.PolicyListeners

onFailure, onSuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.jodah.failsafe.Policy

toExecutor

Constructor Detail

DelayablePolicy

public DelayablePolicy()

Method Detail

getDelayFn

public DelayFunction<R,? extends Throwable> getDelayFn()

Returns the function that determines the next delay before allowing another execution.

See Also:

withDelay(DelayFunction), withDelayOn(DelayFunction, Class), withDelayWhen(DelayFunction, Object)

withDelay

public S withDelay(DelayFunction<R,? extends Throwable> delayFunction)

Sets the delayFunction that computes the next delay before allowing another execution.

Parameters:

delayFunction - the function to use to compute the delay before a next attempt

Throws:

NullPointerException - if delayFunction is null

See Also:

DelayFunction

withDelayOn

public <F extends Throwable> S withDelayOn(DelayFunction<R,F> delayFunction,
                                           Class<F> failure)

Sets the delayFunction that computes the next delay before allowing another execution. Delays will only occur for failures that are assignable from the failure.

Type Parameters:

F - failure type

Parameters:

delayFunction - the function to use to compute the delay before a next attempt

failure - the execution failure that is expected in order to trigger the delay

Throws:

NullPointerException - if delayFunction or failure are null

See Also:

DelayFunction

withDelayWhen

public S withDelayWhen(DelayFunction<R,? extends Throwable> delayFunction,
                       R result)

Sets the delayFunction that computes the next delay before allowing another execution. Delays will only occur for results that equal the result.

Parameters:

delayFunction - the function to use to compute the delay before a next attempt

result - the execution result that is expected in order to trigger the delay

Throws:

NullPointerException - if delayFunction or result are null

See Also:

DelayFunction

computeDelay

protected Duration computeDelay(ExecutionContext context)

Returns a computed delay for the result and context else null if no delay function is configured or the computed delay is invalid.