Package io.smallrye.faulttolerance.api

Interface FaultTolerance.Builder.FallbackBuilder<T,R>

Enclosing interface:

FaultTolerance.Builder<T,R>

public static interface FaultTolerance.Builder.FallbackBuilder<T,R>

Configures a fallback.

See Also:

• @Fallback

Method Summary

Modifier and Type	Method	Description
default FaultTolerance.Builder.FallbackBuilder<T,R>	applyOn(Class<? extends Throwable> value)	Equivalent to applyOn(Collections.singleton(value)).
FaultTolerance.Builder.FallbackBuilder<T,R>	applyOn(Collection<Class<? extends Throwable>> value)	Sets the set of exception types considered failure.
FaultTolerance.Builder<T,R>	done()	Returns the original fault tolerance builder.
FaultTolerance.Builder.FallbackBuilder<T,R>	handler(Function<Throwable,T> value)	Sets the fallback handler in the form of a Function that transforms the exception to the fallback value.
FaultTolerance.Builder.FallbackBuilder<T,R>	handler(Supplier<T> value)	Sets the fallback handler in the form of a fallback value Supplier.
default FaultTolerance.Builder.FallbackBuilder<T,R>	skipOn(Class<? extends Throwable> value)	Equivalent to skipOn(Collections.singleton(value)).
FaultTolerance.Builder.FallbackBuilder<T,R>	skipOn(Collection<Class<? extends Throwable>> value)	Sets the set of exception types considered success.
FaultTolerance.Builder.FallbackBuilder<T,R>	when(Predicate<Throwable> value)	Sets a predicate to determine when an exception should be considered failure and fallback should be applied.
default FaultTolerance.Builder.FallbackBuilder<T,R>	with(Consumer<FaultTolerance.Builder.FallbackBuilder<T,R>> consumer)

Method Details

handler

FaultTolerance.Builder.FallbackBuilder<T,R> handler(Supplier<T> value)

Sets the fallback handler in the form of a fallback value Supplier.

Parameters:

value - the fallback value supplier, must not be null

Returns:

this fallback builder

handler

FaultTolerance.Builder.FallbackBuilder<T,R> handler(Function<Throwable,T> value)

Sets the fallback handler in the form of a Function that transforms the exception to the fallback value.

Parameters:

value - the fallback value function, must not be null

Returns:

this fallback builder

applyOn

FaultTolerance.Builder.FallbackBuilder<T,R> applyOn(Collection<Class<? extends Throwable>> value)

Sets the set of exception types considered failure. Defaults to all exceptions (Throwable).

Parameters:

value - collection of exception types, must not be null

Returns:

this fallback builder

See Also:

• @Fallback.applyOn

applyOn

default FaultTolerance.Builder.FallbackBuilder<T,R> applyOn(Class<? extends Throwable> value)

Equivalent to applyOn(Collections.singleton(value)).

Parameters:

value - an exception class, must not be null

Returns:

this fallback builder

skipOn

FaultTolerance.Builder.FallbackBuilder<T,R> skipOn(Collection<Class<? extends Throwable>> value)

Sets the set of exception types considered success. Defaults to no exception (empty set).

Parameters:

value - collection of exception types, must not be null

Returns:

this fallback builder

See Also:

• @Fallback.skipOn

skipOn

default FaultTolerance.Builder.FallbackBuilder<T,R> skipOn(Class<? extends Throwable> value)

Equivalent to skipOn(Collections.singleton(value)).

Parameters:

value - an exception class, must not be null

Returns:

this fallback builder

when

FaultTolerance.Builder.FallbackBuilder<T,R> when(Predicate<Throwable> value)

Sets a predicate to determine when an exception should be considered failure and fallback should be applied. This is a more general variant of applyOn. Note that there is no generalized skipOn, because all exceptions that do not match this predicate are implicitly considered success.

If this method is called, applyOn and skipOn may not be called.

Parameters:

value - the predicate, must not be null

Returns:

this fallback builder

done

FaultTolerance.Builder<T,R> done()

Returns the original fault tolerance builder.

Returns:

the original fault tolerance builder

with

default FaultTolerance.Builder.FallbackBuilder<T,R> with(Consumer<FaultTolerance.Builder.FallbackBuilder<T,R>> consumer)