Interface RetryState

All Known Subinterfaces:
MutableRetryState
All Known Implementing Classes:
CircuitBreakerRetry
public interface RetryState
An interface that encapsulates the current state of a Retryable operation.
Since:
1.0
Author:
graemerocher

  • Method Details

    • canRetry

      boolean canRetry(Throwable exception)
      Should a retry attempt to occur.
      Parameters:
      exception - The error
      Returns:
      True if it should

    • getMaxAttempts

      int getMaxAttempts()
      Returns the maximum number of attempts.
      Returns:
      The maximum number of attempts

    • currentAttempt

      int currentAttempt()
      Returns the number of the current attempt.
      Returns:
      The number of the current attempt

    • getMultiplier

      OptionalDouble getMultiplier()
      Returns the multiplier to use between delays.
      Returns:
      The multiplier to use between delays

    • getDelay

      Duration getDelay()
      Returns the delay between attempts.
      Returns:
      The delay between attempts

    • getOverallDelay

      Duration getOverallDelay()
      Returns the overall delay so far.
      Returns:
      The overall delay so far

    • getMaxDelay

      Optional<Duration> getMaxDelay()
      Returns the maximum overall delay.
      Returns:
      The maximum overall delay

    • getJitter

      default OptionalDouble getJitter()
      Returns the jitter factor used to apply random deviation to retry delays.
      Returns:
      The jitter factor used to apply random deviation to retry delays

    • getRetryPredicate

      default RetryPredicate getRetryPredicate()
      Returns the retry predicate checking for includes and excludes throwable classes.
      Returns:
      The retry predicate checking for includes and excludes throwable classes

    • getCapturedException

      @Nullable Class<? extends Throwable> getCapturedException()
      Returns the captured exception type, which defaults to Exception.
      Returns:
      The captured exception type

    • open

      default void open()
      Opens the retry state.

    • close

      default void close(@Nullable Throwable exception)
      Closes the RetryState.
      Parameters:
      exception - An exception if an error occurred or null if the operation completed as expected