RetryPolicy (Recurrent 0.4.0 API)

java.lang.Object
- net.jodah.recurrent.RetryPolicy

```
public final class RetryPolicy
extends Object
```
A policy that defines when retries should be performed.
The retryOn methods describe when a retry should be performed for a particular failure. The retryWhen methods describe when a retry should be performed for a particular result. If multiple retryOn or retryWhen conditions are specified, any matching condition can allow a retry.

Constructor Summary

Constructors
Constructor and Description

RetryPolicy()
Creates a retry policy that always retries with no delay.

RetryPolicy(RetryPolicy rp)
Copy constructor.

Constructors
Constructor and Description
`RetryPolicy()` Creates a retry policy that always retries with no delay.
`RetryPolicy(RetryPolicy rp)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsRetries()` Returns whether the policy allows any retries based on the configured maxRetries and maxDuration.
`boolean`	`allowsRetriesFor(Object result, Throwable failure)` Returns whether the policy will allow retries for the `failure`.
`RetryPolicy`	`copy()` Returns a copy of this RetryPolicy.
`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`	`retryFor(Object result)` Specifies when a retry should occur for a particular result.
`RetryPolicy`	`retryOn(Class<? extends Throwable>... failures)` Specifies the failures to retry on.
`RetryPolicy`	`retryOn(Predicate<? extends Throwable> failurePredicate)` Specifies when a retry should occur for a particular failure.
`<T> RetryPolicy`	`retryWhen(BiPredicate<T,? extends Throwable> completionPredicate)` Specifies when a retry should occur for a particular result and failure.
`<T> RetryPolicy`	`retryWhen(Predicate<T> resultPredicate)` Specifies when a retry should occur for a particular result.
`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 always retries with no delay.
  - RetryPolicy
```
public RetryPolicy(RetryPolicy rp)
```
    Copy constructor.
- Method Detail
  - allowsRetries
```
public boolean allowsRetries()
```
    Returns whether the policy allows any retries based on the configured maxRetries and maxDuration.
  - allowsRetriesFor
```
public boolean allowsRetriesFor(Object result,
                                Throwable failure)
```
    Returns whether the policy will allow retries for the failure.
  - copy
```
public RetryPolicy copy()
```
    Returns a copy of this RetryPolicy.
  - 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, double)
  - getDelayMultiplier
```
public double getDelayMultiplier()
```
    Returns the delay multiplier for backoff retries.
    
    See Also:
    
    withBackoff(long, long, TimeUnit, double)
  - 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
  - retryOn
```
public RetryPolicy retryOn(Predicate<? extends Throwable> failurePredicate)
```
    Specifies when a retry should occur for a particular failure. If the retryPredicate returns true then retries may be performed, else the failure will be re-thrown.
    
    Throws:
    
    NullPointerException - if failurePredicate is null
  - retryWhen
```
public <T> RetryPolicy retryWhen(BiPredicate<T,? extends Throwable> completionPredicate)
```
    Specifies when a retry should occur for a particular result and failure. If the completionPredicate returns true then retries may be performed, else the failure will be re-thrown or the result returned.
    
    Throws:
    
    NullPointerException - if completionPredicate is null
  - retryWhen
```
public <T> RetryPolicy retryWhen(Predicate<T> resultPredicate)
```
    Specifies when a retry should occur for a particular result. If the resultPredicate returns true then retries may be performed, else the result will be returned.
    
    Throws:
    
    NullPointerException - if failurePredicate is null
  - retryFor
```
public RetryPolicy retryFor(Object result)
```
    Specifies when a retry should occur for a particular result. If the result matches result then retries may be performed, else the result will be returned.
  - 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
  - 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

Class RetryPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RetryPolicy

RetryPolicy

Method Detail

allowsRetries

allowsRetriesFor

copy

getDelay

getDelayMultiplier

getMaxDelay

getMaxDuration

getMaxRetries

retryOn

retryOn

retryWhen

retryWhen

retryFor

withBackoff

withBackoff

withDelay

withMaxDuration

withMaxRetries