Retry (resilience4j-retry 0.11.0 API)

All Known Implementing Classes:

RetryImpl
```
public interface Retry
```
A Retry instance is thread-safe can be used to decorate multiple requests. A Retry.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Retry.Context`
`static interface`	`Retry.EventPublisher` An EventPublisher which subscribes to the reactive stream of RetryEvents and can be used to register event consumers.
`static interface`	`Retry.Metrics`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Retry.Context`	`context()` Creates a retry Context.
`static <T> java.util.concurrent.Callable<T>`	`decorateCallable(Retry retry, java.util.concurrent.Callable<T> supplier)` Creates a retryable callable.
`static <T,R> io.vavr.CheckedFunction1<T,R>`	`decorateCheckedFunction(Retry retry, io.vavr.CheckedFunction1<T,R> function)` Creates a retryable function.
`static io.vavr.CheckedRunnable`	`decorateCheckedRunnable(Retry retry, io.vavr.CheckedRunnable runnable)` Creates a retryable runnable.
`static <T> io.vavr.CheckedFunction0<T>`	`decorateCheckedSupplier(Retry retry, io.vavr.CheckedFunction0<T> supplier)` Creates a retryable supplier.
`static <T,R> java.util.function.Function<T,R>`	`decorateFunction(Retry retry, java.util.function.Function<T,R> function)` Creates a retryable function.
`static java.lang.Runnable`	`decorateRunnable(Retry retry, java.lang.Runnable runnable)` Creates a retryable runnable.
`static <T> java.util.function.Supplier<T>`	`decorateSupplier(Retry retry, java.util.function.Supplier<T> supplier)` Creates a retryable supplier.
`default <T> T`	`executeCallable(java.util.concurrent.Callable<T> callable)` Decorates and executes the decorated Callable.
`default void`	`executeRunnable(java.lang.Runnable runnable)` Decorates and executes the decorated Runnable.
`default <T> T`	`executeSupplier(java.util.function.Supplier<T> supplier)` Decorates and executes the decorated Supplier.
`Retry.EventPublisher`	`getEventPublisher()` Returns an EventPublisher can be used to register event consumers.
`Retry.Metrics`	`getMetrics()` Get the Metrics of this RateLimiter.
`java.lang.String`	`getName()` Returns the ID of this Retry.
`RetryConfig`	`getRetryConfig()` Returns the RetryConfig of this Retry.
`static Retry`	`of(java.lang.String name, RetryConfig retryConfig)` Creates a Retry with a custom Retry configuration.
`static Retry`	`of(java.lang.String name, java.util.function.Supplier<RetryConfig> retryConfigSupplier)` Creates a Retry with a custom Retry configuration.
`static Retry`	`ofDefaults(java.lang.String name)` Creates a Retry with default configuration.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the ID of this Retry.
    
    Returns:
    
    the ID of this Retry
  - context
```
Retry.Context context()
```
    Creates a retry Context.
    
    Returns:
    
    the retry Context
  - getRetryConfig
```
RetryConfig getRetryConfig()
```
    Returns the RetryConfig of this Retry.
    
    Returns:
    
    the RetryConfig of this Retry
  - getEventPublisher
```
Retry.EventPublisher getEventPublisher()
```
    Returns an EventPublisher can be used to register event consumers.
    
    Returns:
    
    an EventPublisher
  - of
```
static Retry of(java.lang.String name,
                RetryConfig retryConfig)
```
    Creates a Retry with a custom Retry configuration.
    
    Parameters:
    
    name - the ID of the Retry
    
    retryConfig - a custom Retry configuration
    
    Returns:
    
    a Retry with a custom Retry configuration.
  - of
```
static Retry of(java.lang.String name,
                java.util.function.Supplier<RetryConfig> retryConfigSupplier)
```
    Creates a Retry with a custom Retry configuration.
    
    Parameters:
    
    name - the ID of the Retry
    
    retryConfigSupplier - a supplier of a custom Retry configuration
    
    Returns:
    
    a Retry with a custom Retry configuration.
  - ofDefaults
```
static Retry ofDefaults(java.lang.String name)
```
    Creates a Retry with default configuration.
    
    Parameters:
    
    name - the ID of the Retry
    
    Returns:
    
    a Retry with default configuration
  - executeSupplier
```
default <T> T executeSupplier(java.util.function.Supplier<T> supplier)
```
    Decorates and executes the decorated Supplier.
    
    Type Parameters:
    
    T - the type of results supplied by this supplier
    
    Parameters:
    
    supplier - the original Supplier
    
    Returns:
    
    the result of the decorated Supplier.
  - executeCallable
```
default <T> T executeCallable(java.util.concurrent.Callable<T> callable)
                       throws java.lang.Exception
```
    Decorates and executes the decorated Callable.
    
    Type Parameters:
    
    T - the result type of callable
    
    Parameters:
    
    callable - the original Callable
    
    Returns:
    
    the result of the decorated Callable.
    
    Throws:
    
    java.lang.Exception - if unable to compute a result
  - executeRunnable
```
default void executeRunnable(java.lang.Runnable runnable)
```
    Decorates and executes the decorated Runnable.
    
    Parameters:
    
    runnable - the original Runnable
  - decorateCheckedSupplier
```
static <T> io.vavr.CheckedFunction0<T> decorateCheckedSupplier(Retry retry,
                                                               io.vavr.CheckedFunction0<T> supplier)
```
    Creates a retryable supplier.
    
    Type Parameters:
    
    T - the type of results supplied by this supplier
    
    Parameters:
    
    retry - the retry context
    
    supplier - the original function
    
    Returns:
    
    a retryable function
  - decorateCheckedRunnable
```
static io.vavr.CheckedRunnable decorateCheckedRunnable(Retry retry,
                                                       io.vavr.CheckedRunnable runnable)
```
    Creates a retryable runnable.
    
    Parameters:
    
    retry - the retry context
    
    runnable - the original runnable
    
    Returns:
    
    a retryable runnable
  - decorateCheckedFunction
```
static <T,R> io.vavr.CheckedFunction1<T,R> decorateCheckedFunction(Retry retry,
                                                                   io.vavr.CheckedFunction1<T,R> function)
```
    Creates a retryable function.
    
    Type Parameters:
    
    T - the type of the input to the function
    
    R - the result type of the function
    
    Parameters:
    
    retry - the retry context
    
    function - the original function
    
    Returns:
    
    a retryable function
  - decorateSupplier
```
static <T> java.util.function.Supplier<T> decorateSupplier(Retry retry,
                                                           java.util.function.Supplier<T> supplier)
```
    Creates a retryable supplier.
    
    Type Parameters:
    
    T - the type of results supplied by this supplier
    
    Parameters:
    
    retry - the retry context
    
    supplier - the original function
    
    Returns:
    
    a retryable function
  - decorateCallable
```
static <T> java.util.concurrent.Callable<T> decorateCallable(Retry retry,
                                                             java.util.concurrent.Callable<T> supplier)
```
    Creates a retryable callable.
    
    Type Parameters:
    
    T - the type of results supplied by this supplier
    
    Parameters:
    
    retry - the retry context
    
    supplier - the original function
    
    Returns:
    
    a retryable function
  - decorateRunnable
```
static java.lang.Runnable decorateRunnable(Retry retry,
                                           java.lang.Runnable runnable)
```
    Creates a retryable runnable.
    
    Parameters:
    
    retry - the retry context
    
    runnable - the original runnable
    
    Returns:
    
    a retryable runnable
  - decorateFunction
```
static <T,R> java.util.function.Function<T,R> decorateFunction(Retry retry,
                                                               java.util.function.Function<T,R> function)
```
    Creates a retryable function.
    
    Type Parameters:
    
    T - the type of the input to the function
    
    R - the result type of the function
    
    Parameters:
    
    retry - the retry context
    
    function - the original function
    
    Returns:
    
    a retryable function
  - getMetrics
```
Retry.Metrics getMetrics()
```
    Get the Metrics of this RateLimiter.
    
    Returns:
    
    the Metrics of this RateLimiter

Interface Retry

Nested Class Summary

Method Summary

Method Detail

getName

context

getRetryConfig

getEventPublisher

of

of

ofDefaults

executeSupplier

executeCallable

executeRunnable

decorateCheckedSupplier

decorateCheckedRunnable

decorateCheckedFunction

decorateSupplier

decorateCallable

decorateRunnable

decorateFunction

getMetrics