net.jodah.failsafe

Class FailurePolicy<S,R>

java.lang.Object

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

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

Type Parameters:

S - self type

R - result type

All Implemented Interfaces:

Policy<R>

Direct Known Subclasses:

DelayablePolicy, Fallback

public abstract class FailurePolicy<S,R>
extends PolicyListeners<S,R>
implements Policy<R>

A Policy that captures conditions to determine whether an execution is a failure.

• By default, any exception is considered a failure and will be handled by the policy. You can override this by specifying your own handle conditions. The default exception handling condition will only be overridden by another condition that handles failure exceptions such as handle(Class) or handleIf(BiPredicate). Specifying a condition that only handles results, such as handleResult(Object) or handleResultIf(Predicate) will not replace the default exception handling condition.
• If multiple handle conditions are specified, any condition that matches an execution result or failure will trigger policy handling.

Method Summary

Modifier and Type	Method and Description
S	handle(Class<? extends Throwable>... failures) Specifies the failures to handle.
S	handle(Class<? extends Throwable> failure) Specifies the failure to handle.
S	handle(List<Class<? extends Throwable>> failures) Specifies the failures to handle.
S	handleIf(BiPredicate<R,? extends Throwable> resultPredicate) Specifies that a failure has occurred if the resultPredicate matches the execution result.
S	handleIf(Predicate<? extends Throwable> failurePredicate) Specifies that a failure has occurred if the failurePredicate matches the failure.
S	handleResult(R result) Specifies that a failure has occurred if the result matches the execution result.
S	handleResultIf(Predicate<R> resultPredicate) Specifies that a failure has occurred if the resultPredicate matches the execution result.
boolean	isFailure(R result, Throwable failure) Returns whether an execution result can be retried given the configured failure conditions.

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

Method Detail

handle

public S handle(Class<? extends Throwable> failure)

Specifies the failure to handle. Any failure that is assignable from the failure will be handled.

Throws:

NullPointerException - if failure is null

handle

@SafeVarargs
public final S handle(Class<? extends Throwable>... failures)

Specifies the failures to handle. Any failures that are assignable from the failures will be handled.

Throws:

NullPointerException - if failures is null

IllegalArgumentException - if failures is empty

handle

public S handle(List<Class<? extends Throwable>> failures)

Specifies the failures to handle. Any failures that are assignable from the failures will be handled.

Throws:

NullPointerException - if failures is null

IllegalArgumentException - if failures is null or empty

handleIf

public S handleIf(Predicate<? extends Throwable> failurePredicate)

Specifies that a failure has occurred if the failurePredicate matches the failure.

Throws:

NullPointerException - if failurePredicate is null

handleIf

public S handleIf(BiPredicate<R,? extends Throwable> resultPredicate)

Specifies that a failure has occurred if the resultPredicate matches the execution result.

Throws:

NullPointerException - if resultPredicate is null

handleResult

public S handleResult(R result)

Specifies that a failure has occurred if the result matches the execution result.

handleResultIf

public S handleResultIf(Predicate<R> resultPredicate)

Specifies that a failure has occurred if the resultPredicate matches the execution result.

Throws:

NullPointerException - if resultPredicate is null

isFailure

public boolean isFailure(R result,
                         Throwable failure)

Returns whether an execution result can be retried given the configured failure conditions.

See Also:

handle(Class...), handle(List), handleIf(BiPredicate), handleIf(Predicate), #handleResult(R), handleResultIf(Predicate)