net.jodah.recurrent

Class RetryPolicy

java.lang.Object

net.jodah.recurrent.RetryPolicy

public final class RetryPolicy
extends Object

Policy that defines how retries should be performed.

Constructor Summary

Constructors

Constructor and Description
RetryPolicy() Creates a retry policy that retries forever with no delay between retries.

Method Summary

Modifier and Type	Method and Description
boolean	allowsRetries() Returns whether the policy allows any retries based on the configured maxRetries and maxDuration.
boolean	allowsRetriesFor(Throwable failure) Returns whether the policy will allow retries for the failure.
Duration	getDelay() Returns the delay between retries.
double	getDelayMultiplier() Returns the delay multiplier for backoff retries.
Duration	getMaxDelay() Returns the max delay between backoff retries.
Duration	getMaxDuration() Returns the max duration to perform retries for.
int	getMaxRetries() Returns the max retries.
RetryPolicy	retryOn(Class<? extends Throwable>... failures) Specifies the failures to retry on.
RetryPolicy	retryWhen(Predicate<Throwable> retryPredicate) Specifies when a retry should occur for a particular failure.
RetryPolicy	withBackoff(long delay, long maxDelay, TimeUnit timeUnit) Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by a factor of 2.
RetryPolicy	withBackoff(long delay, long maxDelay, TimeUnit timeUnit, double delayMultiplier) Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by the delayMultiplier.
RetryPolicy	withDelay(long delay, TimeUnit timeUnit) Sets the delay between retries.
RetryPolicy	withMaxDuration(long maxDuration, TimeUnit timeUnit) Sets the max duration to perform retries for.
RetryPolicy	withMaxRetries(int maxRetries) Sets the max number of retries to perform.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryPolicy

public RetryPolicy()

Creates a retry policy that retries forever with no delay between retries.

Method Detail

allowsRetries

public boolean allowsRetries()

Returns whether the policy allows any retries based on the configured maxRetries and maxDuration.

allowsRetriesFor

public boolean allowsRetriesFor(Throwable failure)

Returns whether the policy will allow retries for the failure.

getDelay

public Duration getDelay()

Returns the delay between retries. Defaults to Duration.NONE.

See Also:

withDelay(long, TimeUnit), withBackoff(long, long, TimeUnit), #withBackoff(long, long, TimeUnit, int)

getDelayMultiplier

public double getDelayMultiplier()

Returns the delay multiplier for backoff retries.

See Also:

#withBackoff(long, long, TimeUnit, int)

getMaxDelay

public Duration getMaxDelay()

Returns the max delay between backoff retries.

See Also:

withBackoff(long, long, TimeUnit)

getMaxDuration

public Duration getMaxDuration()

Returns the max duration to perform retries for.

See Also:

withMaxDuration(long, TimeUnit)

getMaxRetries

public int getMaxRetries()

Returns the max retries. Defaults to -1, which retries forever.

See Also:

withMaxRetries(int)

retryOn

public RetryPolicy retryOn(Class<? extends Throwable>... failures)

Specifies the failures to retry on. Any failure that is assignable from the failures will be retried.

Throws:

NullPointerException - if failures is null

IllegalArgumentException - if failures is empty

retryWhen

public RetryPolicy retryWhen(Predicate<Throwable> retryPredicate)

Specifies when a retry should occur for a particular failure. Supercedes retryOn(Class...).

Throws:

NullPointerException - if failurePredicate is null

withBackoff

public RetryPolicy withBackoff(long delay,
                               long maxDelay,
                               TimeUnit timeUnit)

Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by a factor of 2.

Throws:

NullPointerException - if timeUnit is null

IllegalArgumentException - if delay is <= 0 or delay is >= maxDelay

withBackoff

public RetryPolicy withBackoff(long delay,
                               long maxDelay,
                               TimeUnit timeUnit,
                               double delayMultiplier)

Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by the delayMultiplier.

Throws:

NullPointerException - if timeUnit is null

IllegalStateException - if delay is >= the maxDuration

IllegalArgumentException - if delay <= 0, delay is >= maxDelay, or the delayMultiplier is <= 1

withDelay

public RetryPolicy withDelay(long delay,
                             TimeUnit timeUnit)

Sets the delay between retries.

Throws:

NullPointerException - if timeUnit is null

IllegalArgumentException - if delay <= 0

IllegalStateException - if delay is >= the maxDuration, or backoff delays have already been set via #withBackoff(Duration, Duration) or #withBackoff(Duration, Duration, int)

withMaxDuration

public RetryPolicy withMaxDuration(long maxDuration,
                                   TimeUnit timeUnit)

Sets the max duration to perform retries for.

Throws:

NullPointerException - if timeUnit is null

IllegalStateException - if maxDuration is <= the delay

withMaxRetries

public RetryPolicy withMaxRetries(int maxRetries)

Sets the max number of retries to perform. -1 indicates to retry forever.

Throws:

IllegalArgumentException - if maxRetries < -1