Package dev.failsafe

Class PolicyBuilder<S,C extends PolicyConfig<R>,R>

java.lang.Object

dev.failsafe.PolicyBuilder<S,C,R>

Type Parameters:

S - self type

C - config type

R - result type

All Implemented Interfaces:

PolicyListeners<S,R>

Direct Known Subclasses:

BulkheadBuilder, FailurePolicyBuilder, RateLimiterBuilder, TimeoutBuilder

public abstract class PolicyBuilder<S,C extends PolicyConfig<R>,R>
extends Object
implements PolicyListeners<S,R>

Builds policies.

Field Summary

Fields

Modifier and Type	Field	Description
protected C	config

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PolicyBuilder(C config)

Method Summary

Modifier and Type	Method	Description
S	onFailure(EventListener<ExecutionCompletedEvent<R>> listener)	Registers the listener to be called when the policy fails to handle an execution.
S	onSuccess(EventListener<ExecutionCompletedEvent<R>> listener)	Registers the listener to be called when the policy succeeds in handling an execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

config

protected C extends PolicyConfig<R> config

Constructor Details

PolicyBuilder

protected PolicyBuilder(C config)

Method Details

onFailure

public S onFailure(EventListener<ExecutionCompletedEvent<R>> listener)

Description copied from interface: PolicyListeners

Registers the listener to be called when the policy fails to handle an execution. This means that not only was the supplied execution considered a failure by the policy, but that the policy was unable to produce a successful result.

Note: Any exceptions that are thrown from within the listener are ignored. To provide an alternative result for a failed execution, use a Fallback.

Specified by:

onFailure in interface PolicyListeners<S,C extends PolicyConfig<R>>

onSuccess

public S onSuccess(EventListener<ExecutionCompletedEvent<R>> listener)

Description copied from interface: PolicyListeners

Registers the listener to be called when the policy succeeds in handling an execution. This means that the supplied execution either succeeded, or if it failed, the policy was able to produce a successful result.

Note: Any exceptions that are thrown from within the listener are ignored.

Specified by:

onSuccess in interface PolicyListeners<S,C extends PolicyConfig<R>>