com.github.rholder.retry

Class RetryerBuilder<V>

java.lang.Object

com.github.rholder.retry.RetryerBuilder<V>

Type Parameters:

V - result of a Retryer's call, the type of the call return value

public class RetryerBuilder<V>
extends java.lang.Object

A builder used to configure and create a Retryer.

Method Summary

Methods

Modifier and Type	Method and Description
Retryer<V>	build() Builds the retryer.
static <V> RetryerBuilder<V>	newBuilder() Constructs a new builder
RetryerBuilder<V>	retryIfException() Configures the retryer to retry if an exception (i.e.
RetryerBuilder<V>	retryIfException(com.google.common.base.Predicate<java.lang.Throwable> exceptionPredicate) Configures the retryer to retry if an exception satisfying the given predicate is thrown by the call.
RetryerBuilder<V>	retryIfExceptionOfType(java.lang.Class<? extends java.lang.Throwable> exceptionClass) Configures the retryer to retry if an exception of the given class (or subclass of the given class) is thrown by the call.
RetryerBuilder<V>	retryIfResult(com.google.common.base.Predicate<V> resultPredicate) Configures the retryer to retry if the result satisfies the given predicate.
RetryerBuilder<V>	retryIfRuntimeException() Configures the retryer to retry if a runtime exception (i.e.
RetryerBuilder<V>	withAttemptTimeLimiter(AttemptTimeLimiter<V> attemptTimeLimiter) Configures the retryer to limit the duration of any particular attempt by the given duration.
RetryerBuilder<V>	withBlockStrategy(BlockStrategy blockStrategy) Sets the block strategy used to decide how to block between retry attempts.
RetryerBuilder<V>	withRetryListener(RetryListener listener) Adds a listener that will be notified of each attempt that is made
RetryerBuilder<V>	withStopStrategy(StopStrategy stopStrategy) Sets the stop strategy used to decide when to stop retrying.
RetryerBuilder<V>	withWaitStrategy(WaitStrategy waitStrategy) Sets the wait strategy used to decide how long to sleep between failed attempts.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static <V> RetryerBuilder<V> newBuilder()

Constructs a new builder

Type Parameters:

V - result of a Retryer's call, the type of the call return value

Returns:

the new builder

withRetryListener

public RetryerBuilder<V> withRetryListener(@Nonnull
                                  RetryListener listener)

Adds a listener that will be notified of each attempt that is made

Parameters:

listener - Listener to add

Returns:

this

withWaitStrategy

public RetryerBuilder<V> withWaitStrategy(@Nonnull
                                 WaitStrategy waitStrategy)
                                   throws java.lang.IllegalStateException

Sets the wait strategy used to decide how long to sleep between failed attempts. The default strategy is to retry immediately after a failed attempt.

Parameters:

waitStrategy - the strategy used to sleep between failed attempts

Returns:

this

Throws:

java.lang.IllegalStateException - if a wait strategy has already been set.

withStopStrategy

public RetryerBuilder<V> withStopStrategy(@Nonnull
                                 StopStrategy stopStrategy)
                                   throws java.lang.IllegalStateException

Sets the stop strategy used to decide when to stop retrying. The default strategy is to not stop at all .

Parameters:

stopStrategy - the strategy used to decide when to stop retrying

Returns:

this

Throws:

java.lang.IllegalStateException - if a stop strategy has already been set.

withBlockStrategy

public RetryerBuilder<V> withBlockStrategy(@Nonnull
                                  BlockStrategy blockStrategy)
                                    throws java.lang.IllegalStateException

Sets the block strategy used to decide how to block between retry attempts. The default strategy is to use Thread#sleep().

Parameters:

blockStrategy - the strategy used to decide how to block between retry attempts

Returns:

this

Throws:

java.lang.IllegalStateException - if a block strategy has already been set.

withAttemptTimeLimiter

public RetryerBuilder<V> withAttemptTimeLimiter(@Nonnull
                                       AttemptTimeLimiter<V> attemptTimeLimiter)

Configures the retryer to limit the duration of any particular attempt by the given duration.

Parameters:

attemptTimeLimiter - to apply to each attempt

Returns:

this

retryIfException

public RetryerBuilder<V> retryIfException()

Configures the retryer to retry if an exception (i.e. any Exception or subclass of Exception) is thrown by the call.

Returns:

this

retryIfRuntimeException

public RetryerBuilder<V> retryIfRuntimeException()

Configures the retryer to retry if a runtime exception (i.e. any RuntimeException or subclass of RuntimeException) is thrown by the call.

Returns:

this

retryIfExceptionOfType

public RetryerBuilder<V> retryIfExceptionOfType(@Nonnull
                                       java.lang.Class<? extends java.lang.Throwable> exceptionClass)

Configures the retryer to retry if an exception of the given class (or subclass of the given class) is thrown by the call.

Parameters:

exceptionClass - the type of the exception which should cause the retryer to retry

Returns:

this

retryIfException

public RetryerBuilder<V> retryIfException(@Nonnull
                                 com.google.common.base.Predicate<java.lang.Throwable> exceptionPredicate)

Configures the retryer to retry if an exception satisfying the given predicate is thrown by the call.

Parameters:

exceptionPredicate - the predicate which causes a retry if satisfied

Returns:

this

retryIfResult

public RetryerBuilder<V> retryIfResult(@Nonnull
                              com.google.common.base.Predicate<V> resultPredicate)

Configures the retryer to retry if the result satisfies the given predicate.

Parameters:

resultPredicate - a predicate applied to the result, and which causes the retryer to retry if the predicate is satisfied

Returns:

this

build

public Retryer<V> build()

Builds the retryer.

Returns:

the built retryer.