com.github.rholder.retry

Class StopStrategies

java.lang.Object

com.github.rholder.retry.StopStrategies

public final class StopStrategies
extends java.lang.Object

Factory class for StopStrategy instances.

Method Summary

Methods

Modifier and Type	Method and Description
static StopStrategy	neverStop() Returns a stop strategy which never stops retrying.
static StopStrategy	stopAfterAttempt(int attemptNumber) Returns a stop strategy which stops after N failed attempts.
static StopStrategy	stopAfterDelay(long delayInMillis) Deprecated. Use stopAfterDelay(long, TimeUnit) instead.
static StopStrategy	stopAfterDelay(long duration, java.util.concurrent.TimeUnit timeUnit) Returns a stop strategy which stops after a given delay.

Methods inherited from class java.lang.Object

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

Method Detail

neverStop

public static StopStrategy neverStop()

Returns a stop strategy which never stops retrying. It might be best to try not to abuse services with this kind of behavior when small wait intervals between retry attempts are being used.

Returns:

a stop strategy which never stops

stopAfterAttempt

public static StopStrategy stopAfterAttempt(int attemptNumber)

Returns a stop strategy which stops after N failed attempts.

Parameters:

attemptNumber - the number of failed attempts before stopping

Returns:

a stop strategy which stops after attemptNumber attempts

stopAfterDelay

@Deprecated
public static StopStrategy stopAfterDelay(long delayInMillis)

Deprecated. Use stopAfterDelay(long, TimeUnit) instead.

Returns a stop strategy which stops after a given delay. If an unsuccessful attempt is made, this StopStrategy will check if the amount of time that's passed from the first attempt has exceeded the given delay amount. If it has exceeded this delay, then using this strategy causes the retrying to stop.

Parameters:

delayInMillis - the delay, in milliseconds, starting from first attempt

Returns:

a stop strategy which stops after delayInMillis time in milliseconds

stopAfterDelay

public static StopStrategy stopAfterDelay(long duration,
                          @Nonnull
                          java.util.concurrent.TimeUnit timeUnit)

Returns a stop strategy which stops after a given delay. If an unsuccessful attempt is made, this StopStrategy will check if the amount of time that's passed from the first attempt has exceeded the given delay amount. If it has exceeded this delay, then using this strategy causes the retrying to stop.

Parameters:

duration - the delay, starting from first attempt

timeUnit - the unit of the duration

Returns:

a stop strategy which stops after delayInMillis time in milliseconds