Browse Source

Update Javadoc due to changes in retry support

See gh-35940
pull/35992/head
Sam Brannen 1 week ago
parent
commit
75e3f44a7b
  1. 7
      spring-core/src/main/java/org/springframework/core/retry/RetryException.java
  2. 6
      spring-core/src/main/java/org/springframework/core/retry/RetryListener.java

7
spring-core/src/main/java/org/springframework/core/retry/RetryException.java

@ -70,9 +70,7 @@ public class RetryException extends Exception implements RetryState {
/** /**
* Get the last exception thrown by the {@link Retryable} operation, or an * Get the last exception thrown by the {@link Retryable} operation.
* {@link InterruptedException} thrown while sleeping for the current
* {@code BackOff} duration.
*/ */
@Override @Override
public final Throwable getCause() { public final Throwable getCause() {
@ -102,7 +100,8 @@ public class RetryException extends Exception implements RetryState {
} }
/** /**
* Return the exception from the last invocation (also exposed as a cause). * Return the exception from the last invocation (also exposed as the
* {@linkplain #getCause() cause}).
* @since 7.0.2 * @since 7.0.2
*/ */
@Override @Override

6
spring-core/src/main/java/org/springframework/core/retry/RetryListener.java

@ -99,9 +99,9 @@ public interface RetryListener {
* Called if the {@link RetryPolicy} is interrupted between retry attempts. * Called if the {@link RetryPolicy} is interrupted between retry attempts.
* @param retryPolicy the {@code RetryPolicy} * @param retryPolicy the {@code RetryPolicy}
* @param retryable the {@link Retryable} operation * @param retryable the {@link Retryable} operation
* @param exception the resulting {@link RetryException}, with an * @param exception the resulting {@link RetryException}, with the last
* {@link InterruptedException} as the cause and any exceptions from previous * exception thrown by the {@code Retryable} operation as the cause and any
* invocations of the {@code Retryable} operation as suppressed exceptions * exceptions from previous attempts as suppressed exceptions
* @see RetryException#getExceptions() * @see RetryException#getExceptions()
* @see RetryException#getRetryCount() * @see RetryException#getRetryCount()
*/ */

Loading…
Cancel
Save