Package io.smallrye.faulttolerance.api

Interface TypedGuard.Builder.FallbackBuilder<T>

Enclosing interface:

TypedGuard.Builder<T>

public static interface TypedGuard.Builder.FallbackBuilder<T>

Configures a fallback.

See Also:

• @Fallback

Method Summary

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

Method Details

handler

TypedGuard.Builder.FallbackBuilder<T> 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

TypedGuard.Builder.FallbackBuilder<T> 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

TypedGuard.Builder.FallbackBuilder<T> 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

TypedGuard.Builder.FallbackBuilder<T> applyOn(Class<? extends Throwable> value)

Equivalent to applyOn(Set.of(value)).

Parameters:

value - an exception class, must not be null

Returns:

this fallback builder

skipOn

TypedGuard.Builder.FallbackBuilder<T> 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

TypedGuard.Builder.FallbackBuilder<T> skipOn(Class<? extends Throwable> value)

Equivalent to skipOn(Set.of(value)).

Parameters:

value - an exception class, must not be null

Returns:

this fallback builder

when

TypedGuard.Builder.FallbackBuilder<T> 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

TypedGuard.Builder<T> done()

Returns the original fault tolerance builder.

Returns:

the original fault tolerance builder

with

default TypedGuard.Builder.FallbackBuilder<T> with(Consumer<TypedGuard.Builder.FallbackBuilder<T>> consumer)