Fallback (Failsafe 2.4.0 API)

java.lang.Object
- net.jodah.failsafe.PolicyListeners<S,R>
- - net.jodah.failsafe.FailurePolicy<Fallback<R>,R>
  - - net.jodah.failsafe.Fallback<R>

Type Parameters:

R - result type

All Implemented Interfaces:

Policy<R>
```
public class Fallback<R>
extends FailurePolicy<Fallback<R>,R>
```
A Policy that handles failures using a fallback function or result.
Note: Fallback extends FailurePolicy PolicyListeners which offer additional configuration.

Field Summary

Fields
Modifier and Type Field and Description

static Fallback<Void> VOID
A fallback that will return a void result if execution fails.

Fields
Modifier and Type	Field and Description
`static Fallback<Void>`	`VOID` A fallback that will return a void result if execution fails.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isAsync()` Returns whether the Fallback is configured to handle execution results asynchronously, separate from execution..
`static <R> Fallback<R>`	`of(CheckedConsumer<ExecutionAttemptedEvent<? extends R>> fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`of(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends R> fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`of(CheckedRunnable fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`of(CheckedSupplier<? extends R> fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`of(R fallback)` Returns the `fallback` result to be returned if execution fails.
`static <R> Fallback<R>`	`ofAsync(CheckedConsumer<ExecutionAttemptedEvent<? extends R>> fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`static <R> Fallback<R>`	`ofAsync(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends R> fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`static <R> Fallback<R>`	`ofAsync(CheckedRunnable fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`static <R> Fallback<R>`	`ofAsync(CheckedSupplier<? extends R> fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`static <R> Fallback<R>`	`ofException(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends Exception> fallback)` Returns the `fallback` to be executed if execution fails and allows an alternative exception to be supplied instead.
`static <R> Fallback<R>`	`ofStage(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends CompletionStage<R>> fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`ofStage(CheckedSupplier<? extends CompletionStage<R>> fallback)` Returns the `fallback` to be executed if execution fails.
`static <R> Fallback<R>`	`ofStageAsync(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends CompletionStage<R>> fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`static <R> Fallback<R>`	`ofStageAsync(CheckedSupplier<? extends CompletionStage<R>> fallback)` Returns the `fallback` to be executed asynchronously if execution fails.
`Fallback<R>`	`onFailedAttempt(CheckedConsumer<? extends ExecutionAttemptedEvent<R>> listener)` Registers the `listener` to be called when an execution attempt fails.
`PolicyExecutor`	`toExecutor(AbstractExecution execution)` Returns an `PolicyExecutor` capable of performing an execution in the context of a Policy and handling results according to the Policy.

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

- Field Detail
  - VOID
```
public static final Fallback<Void> VOID
```
    A fallback that will return a void result if execution fails.
- Method Detail
  - of
```
public static <R> Fallback<R> of(CheckedRunnable fallback)
```
    Returns the fallback to be executed if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - of
```
public static <R> Fallback<R> of(CheckedSupplier<? extends R> fallback)
```
    Returns the fallback to be executed if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - of
```
public static <R> Fallback<R> of(CheckedConsumer<ExecutionAttemptedEvent<? extends R>> fallback)
```
    Returns the fallback to be executed if execution fails. The fallback accepts an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - of
```
public static <R> Fallback<R> of(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends R> fallback)
```
    Returns the fallback to be executed if execution fails. The fallback applies an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofException
```
public static <R> Fallback<R> ofException(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends Exception> fallback)
```
    Returns the fallback to be executed if execution fails and allows an alternative exception to be supplied instead. The fallback applies an ExecutionAttemptedEvent and must return an exception.
    
    Throws:
    
    NullPointerException - if fallback is null
  - of
```
public static <R> Fallback<R> of(R fallback)
```
    Returns the fallback result to be returned if execution fails.
  - ofAsync
```
public static <R> Fallback<R> ofAsync(CheckedRunnable fallback)
```
    Returns the fallback to be executed asynchronously if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofAsync
```
public static <R> Fallback<R> ofAsync(CheckedSupplier<? extends R> fallback)
```
    Returns the fallback to be executed asynchronously if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofAsync
```
public static <R> Fallback<R> ofAsync(CheckedConsumer<ExecutionAttemptedEvent<? extends R>> fallback)
```
    Returns the fallback to be executed asynchronously if execution fails. The fallback accepts an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofAsync
```
public static <R> Fallback<R> ofAsync(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends R> fallback)
```
    Returns the fallback to be executed asynchronously if execution fails. The fallback applies an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofStage
```
public static <R> Fallback<R> ofStage(CheckedSupplier<? extends CompletionStage<R>> fallback)
```
    Returns the fallback to be executed if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofStage
```
public static <R> Fallback<R> ofStage(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends CompletionStage<R>> fallback)
```
    Returns the fallback to be executed if execution fails. The fallback accepts an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofStageAsync
```
public static <R> Fallback<R> ofStageAsync(CheckedSupplier<? extends CompletionStage<R>> fallback)
```
    Returns the fallback to be executed asynchronously if execution fails.
    
    Throws:
    
    NullPointerException - if fallback is null
  - ofStageAsync
```
public static <R> Fallback<R> ofStageAsync(CheckedFunction<ExecutionAttemptedEvent<? extends R>,? extends CompletionStage<R>> fallback)
```
    Returns the fallback to be executed asynchronously if execution fails. The fallback accepts an ExecutionAttemptedEvent.
    
    Throws:
    
    NullPointerException - if fallback is null
  - isAsync
```
public boolean isAsync()
```
    Returns whether the Fallback is configured to handle execution results asynchronously, separate from execution..
  - onFailedAttempt
```
public Fallback<R> onFailedAttempt(CheckedConsumer<? extends ExecutionAttemptedEvent<R>> listener)
```
    Registers the listener to be called when an execution attempt fails. You can also use onFailure to determine when the execution attempt fails and and the fallback result fails.
    Note: Any exceptions that are thrown from within the listener are ignored.
  - toExecutor
```
public PolicyExecutor toExecutor(AbstractExecution execution)
```
    Description copied from interface: Policy
    
    Returns an PolicyExecutor capable of performing an execution in the context of a Policy and handling results according to the Policy.

Class Fallback<R>

Field Summary

Method Summary

Methods inherited from class net.jodah.failsafe.FailurePolicy

Methods inherited from class net.jodah.failsafe.PolicyListeners

Methods inherited from class java.lang.Object

Field Detail

VOID

Method Detail

of

of

of

of

ofException

of

ofAsync

ofAsync

ofAsync

ofAsync

ofStage

ofStage

ofStageAsync

ofStageAsync

isAsync

onFailedAttempt

toExecutor