Skip to content

Commit d74b863

Browse files
committed
Polish Javadoc for core retry functionality
See gh-34716
1 parent 8b9e620 commit d74b863

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

spring-core/src/main/java/org/springframework/core/retry/RetryExecution.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
* Strategy interface to define a retry execution created for a given
2121
* {@link RetryPolicy}.
2222
*
23+
* <p>A {@code RetryExecution} is effectively an executable instance of a given
24+
* {@code RetryPolicy}.
25+
*
2326
* <p>Implementations may be stateful but do not need to be thread-safe.
2427
*
2528
* @author Mahmoud Ben Hassine

spring-core/src/main/java/org/springframework/core/retry/RetryTemplate.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public class RetryTemplate implements RetryOperations {
6666
protected RetryListener retryListener = new RetryListener() {
6767
};
6868

69+
6970
/**
7071
* Create a new {@code RetryTemplate} with maximum 3 retry attempts and a
7172
* fixed backoff of 1 second.
@@ -95,6 +96,7 @@ public RetryTemplate(RetryPolicy retryPolicy, BackOff backOffPolicy) {
9596
this.backOffPolicy = backOffPolicy;
9697
}
9798

99+
98100
/**
99101
* Set the {@link RetryPolicy} to use.
100102
* <p>Defaults to {@code new MaxRetryAttemptsPolicy()}.
@@ -108,7 +110,7 @@ public void setRetryPolicy(RetryPolicy retryPolicy) {
108110

109111
/**
110112
* Set the {@link BackOff} policy to use.
111-
* <p>Defaults to {@code new FixedBackOff(1000, Long.MAX_VALUE))}.
113+
* <p>Defaults to {@code new FixedBackOff(Duration.ofSeconds(1))}.
112114
* @param backOffPolicy the backoff policy to use
113115
* @see FixedBackOff
114116
*/

spring-core/src/main/java/org/springframework/core/retry/support/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Support package for the core retry functionality containing common retry policies.
2+
* Support package for the core retry functionality.
33
*/
44
@NullMarked
55
package org.springframework.core.retry.support;

0 commit comments

Comments
 (0)