EBRetryStrategyBackoff.Builder (Retry mechanism 0.1.0 API)

java.lang.Object
- com.enigmabridge.retry.EBRetryStrategyBackoff.Builder

Enclosing class:

EBRetryStrategyBackoff
```
public static class EBRetryStrategyBackoff.Builder
extends Object
```
Builder for EBRetryStrategyBackoff.

Implementation is not thread-safe.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EBRetryStrategyBackoff`	`build()` Builds a new instance of `EBRetryStrategyBackoff`.
`int`	`getInitialIntervalMillis()` Returns the initial retry interval in milliseconds.
`int`	`getMaxAttempts()` Maximum number of attempts
`int`	`getMaxElapsedTimeMillis()` Returns the maximum elapsed time in milliseconds.
`int`	`getMaxIntervalMillis()` Returns the maximum value of the back off period in milliseconds.
`double`	`getMultiplier()` Returns the value to multiply the current interval with for each retry attempt.
`double`	`getRandomizationFactor()` Returns the randomization factor to use for creating a range around the retry interval.
`EBRetryStrategyBackoff.Builder`	`setInitialIntervalMillis(int initialIntervalMillis)` Sets the initial retry interval in milliseconds.
`EBRetryStrategyBackoff.Builder`	`setJSON(org.json.JSONObject json)` Reads serialized settings from the JSON
`EBRetryStrategyBackoff.Builder`	`setMaxAttempts(int maxAttempts)` Sets maximum number of attempts before quitting.
`EBRetryStrategyBackoff.Builder`	`setMaxElapsedTimeMillis(int maxElapsedTimeMillis)` Sets the maximum elapsed time in milliseconds.
`EBRetryStrategyBackoff.Builder`	`setMaxIntervalMillis(int maxIntervalMillis)` Sets the maximum value of the back off period in milliseconds.
`EBRetryStrategyBackoff.Builder`	`setMultiplier(double multiplier)` Sets the value to multiply the current interval with for each retry attempt.
`EBRetryStrategyBackoff.Builder`	`setRandomizationFactor(double randomizationFactor)` Sets the randomization factor to use for creating a range around the retry interval.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public EBRetryStrategyBackoff build()
```
    Builds a new instance of EBRetryStrategyBackoff.
    
    Returns:
    
    new instance of EBRetryStrategyBackoff
  - getInitialIntervalMillis
```
public final int getInitialIntervalMillis()
```
    Returns the initial retry interval in milliseconds. The default value is EBRetryStrategyBackoff.DEFAULT_INITIAL_INTERVAL_MILLIS.
    
    Returns:
    
    int
  - setInitialIntervalMillis
```
public EBRetryStrategyBackoff.Builder setInitialIntervalMillis(int initialIntervalMillis)
```
    Sets the initial retry interval in milliseconds. The default value is EBRetryStrategyBackoff.DEFAULT_INITIAL_INTERVAL_MILLIS. Must be > 0.
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Parameters:
    
    initialIntervalMillis - int
    
    Returns:
    
    new instance of Builder
  - getRandomizationFactor
```
public final double getRandomizationFactor()
```
    Returns the randomization factor to use for creating a range around the retry interval. The default value is EBRetryStrategyBackoff.DEFAULT_RANDOMIZATION_FACTOR.
    
    A randomization factor of 0.5 results in a random period ranging between 50% below and 50% above the retry interval.
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Returns:
    
    double
  - setRandomizationFactor
```
public EBRetryStrategyBackoff.Builder setRandomizationFactor(double randomizationFactor)
```
    Sets the randomization factor to use for creating a range around the retry interval. The default value is EBRetryStrategyBackoff.DEFAULT_RANDOMIZATION_FACTOR. Must fall in the range 0 <= randomizationFactor < 1.
    
    A randomization factor of 0.5 results in a random period ranging between 50% below and 50% above the retry interval.
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Parameters:
    
    randomizationFactor - double
    
    Returns:
    
    new instance of Builder
  - getMultiplier
```
public final double getMultiplier()
```
    Returns the value to multiply the current interval with for each retry attempt. The default value is EBRetryStrategyBackoff.DEFAULT_MULTIPLIER.
    
    Returns:
    
    double
  - setMultiplier
```
public EBRetryStrategyBackoff.Builder setMultiplier(double multiplier)
```
    Sets the value to multiply the current interval with for each retry attempt. The default value is EBRetryStrategyBackoff.DEFAULT_MULTIPLIER. Must be >= 1.
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Parameters:
    
    multiplier - double
    
    Returns:
    
    new instance of Builder
  - getMaxIntervalMillis
```
public final int getMaxIntervalMillis()
```
    Returns the maximum value of the back off period in milliseconds. Once the current interval reaches this value it stops increasing. The default value is EBRetryStrategyBackoff.DEFAULT_MAX_INTERVAL_MILLIS. Must be >= initialInterval.
    
    Returns:
    
    int
  - setMaxIntervalMillis
```
public EBRetryStrategyBackoff.Builder setMaxIntervalMillis(int maxIntervalMillis)
```
    Sets the maximum value of the back off period in milliseconds. Once the current interval reaches this value it stops increasing. The default value is EBRetryStrategyBackoff.DEFAULT_MAX_INTERVAL_MILLIS.
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Parameters:
    
    maxIntervalMillis - int
    
    Returns:
    
    new Builder instance
  - getMaxElapsedTimeMillis
```
public final int getMaxElapsedTimeMillis()
```
    Returns the maximum elapsed time in milliseconds. The default value is EBRetryStrategyBackoff.DEFAULT_MAX_ELAPSED_TIME_MILLIS.
    
    If the time elapsed since an EBRetryStrategyBackoff instance is created goes past the max_elapsed_time then the method EBRetryStrategyBackoff.nextBackOffMillis() starts returning BackOff.STOP. The elapsed time can be reset by calling EBRetryStrategyBackoff.reset().
    
    Returns:
    
    int
  - setMaxElapsedTimeMillis
```
public EBRetryStrategyBackoff.Builder setMaxElapsedTimeMillis(int maxElapsedTimeMillis)
```
    Sets the maximum elapsed time in milliseconds. The default value is EBRetryStrategyBackoff.DEFAULT_MAX_ELAPSED_TIME_MILLIS. Must be > 0.
    
    If the time elapsed since an EBRetryStrategyBackoff instance is created goes past the max_elapsed_time then the method EBRetryStrategyBackoff.nextBackOffMillis() starts returning BackOff.STOP. The elapsed time can be reset by calling EBRetryStrategyBackoff.reset().
    
    Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
    
    Parameters:
    
    maxElapsedTimeMillis - int
    
    Returns:
    
    new Builder instance
  - getMaxAttempts
```
public int getMaxAttempts()
```
    Maximum number of attempts
    
    Returns:
    
    number of attempts
  - setMaxAttempts
```
public EBRetryStrategyBackoff.Builder setMaxAttempts(int maxAttempts)
```
    Sets maximum number of attempts before quitting. The default value is EBRetryStrategyBackoff.DEFAULT_MAX_ATTEMPTS. If is < 0 this limit is not taken into account.
    
    Parameters:
    
    maxAttempts - number of attempts
    
    Returns:
    
    this
  - setJSON
```
public EBRetryStrategyBackoff.Builder setJSON(org.json.JSONObject json)
```
    Reads serialized settings from the JSON
    
    Parameters:
    
    json - json to use
    
    Returns:
    
    this

Class EBRetryStrategyBackoff.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

getInitialIntervalMillis

setInitialIntervalMillis

getRandomizationFactor

setRandomizationFactor

getMultiplier

setMultiplier

getMaxIntervalMillis

setMaxIntervalMillis

getMaxElapsedTimeMillis

setMaxElapsedTimeMillis

getMaxAttempts

setMaxAttempts

setJSON