Interface Fallback<R>

Type Parameters:

R - result type

All Superinterfaces:

Policy<R>

All Known Implementing Classes:

FallbackImpl

public interface Fallback<R>
extends Policy<R>

A Policy that handles failures using a fallback function or result.

This class is threadsafe.

See Also:

• TimeoutConfig
• FallbackBuilder

Method Summary

Modifier and Type	Method	Description
static <R> FallbackBuilder<R>	builder(FallbackConfig<R> config)	Creates a new FallbackBuilder that will be based on the config.
static <R> FallbackBuilder<R>	builder(CheckedConsumer<ExecutionAttemptedEvent<? extends R>> fallback)	Returns the fallback to be executed if execution fails.
static <R> FallbackBuilder<R>	builder(CheckedFunction<ExecutionAttemptedEvent<? extends R>, ? extends R> fallback)	Returns the fallback to be executed if execution fails.
static <R> FallbackBuilder<R>	builder(CheckedRunnable fallback)	Returns the fallback to be executed if execution fails.
static <R> FallbackBuilder<R>	builder(CheckedSupplier<? extends R> fallback)	Returns the fallback to be executed if execution fails.
static <R> FallbackBuilder<R>	builder(R fallbackResult)	Returns the fallbackResult to be provided if execution fails.
static <R> FallbackBuilder<R>	builderOfException(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> FallbackBuilder<R>	builderOfStage(CheckedFunction<ExecutionAttemptedEvent<? extends R>, ? extends CompletionStage<R>> fallback)	Returns the fallback to be executed if execution fails.
static <R> FallbackBuilder<R>	builderOfStage(CheckedSupplier<? extends CompletionStage<R>> fallback)	Returns the fallback to be executed if execution fails.
FallbackConfig<R>	getConfig()	Returns the FallbackConfig that the Fallback was built with.
static Fallback<Void>	none()	Returns a fallback that will return a null if execution fails.
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 fallbackResult)	Returns the fallbackResult to be provided 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.

Methods inherited from interface Policy

toExecutor

Method Details

builder

static <R> FallbackBuilder<R> builder(FallbackConfig<R> config)

Creates a new FallbackBuilder that will be based on the config.

builder

static <R> FallbackBuilder<R> builder(CheckedRunnable fallback)

Returns the fallback to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

builder

static <R> FallbackBuilder<R> builder(CheckedSupplier<? extends R> fallback)

Returns the fallback to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

builder

static <R> FallbackBuilder<R> builder(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

builder

static <R> FallbackBuilder<R> builder(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

builder

static <R> FallbackBuilder<R> builder(R fallbackResult)

Returns the fallbackResult to be provided if execution fails.

builderOfException

static <R> FallbackBuilder<R> builderOfException(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

builderOfStage

static <R> FallbackBuilder<R> builderOfStage(CheckedSupplier<? extends CompletionStage<R>> fallback)

Returns the fallback to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

builderOfStage

static <R> FallbackBuilder<R> builderOfStage(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

of

static <R> Fallback<R> of(CheckedRunnable fallback)

Returns the fallback to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

of

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

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

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

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

static <R> Fallback<R> of(R fallbackResult)

Returns the fallbackResult to be provided if execution fails.

ofStage

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

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

none

static Fallback<Void> none()

Returns a fallback that will return a null if execution fails.

getConfig

FallbackConfig<R> getConfig()

Returns the FallbackConfig that the Fallback was built with.

Specified by:

getConfig in interface Policy<R>