Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Javadoc for RetryPolicy.Builder

Browse Source
This commit is contained in:
Sam Brannen
2025-06-16 14:31:50 +02:00
parent 09372b72ae
commit f41a568b1d
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-core/src/main/java/org/springframework/core/retry/RetryPolicy.java
View File

@@ -99,6 +99,8 @@ public interface RetryPolicy {
/** /**
* Specify the maximum number of retry attempts. * Specify the maximum number of retry attempts.
* <p>If a {@code maxAttempts} value has already been configured, the
* supplied value will override the existing value.
* @param maxAttempts the maximum number of retry attempts; must be * @param maxAttempts the maximum number of retry attempts; must be
* greater than zero * greater than zero
* @return this {@code Builder} instance for chained method invocations * @return this {@code Builder} instance for chained method invocations
@@ -111,6 +113,8 @@ public interface RetryPolicy {
/** /**
* Specify the maximum retry {@link Duration}. * Specify the maximum retry {@link Duration}.
* <p>If a {@code maxDuration} value has already been configured, the
* supplied value will override the existing value.
* @param maxDuration the maximum retry duration; must be positive * @param maxDuration the maximum retry duration; must be positive
* @return this {@code Builder} instance for chained method invocations * @return this {@code Builder} instance for chained method invocations
*/ */
@@ -123,6 +127,9 @@ public interface RetryPolicy {
/** /**
* Specify the types of exceptions for which the {@link RetryPolicy} * Specify the types of exceptions for which the {@link RetryPolicy}
* should retry a failed operation. * should retry a failed operation.
* <p>Defaults to all exception types.
* <p>If included exception types have already been configured, the supplied
* types will be added to the existing list of included types.
* <p>This can be combined with {@link #excludes(Class...)} and * <p>This can be combined with {@link #excludes(Class...)} and
* {@link #predicate(Predicate)}. * {@link #predicate(Predicate)}.
* @param types the types of exceptions to include in the policy * @param types the types of exceptions to include in the policy
@@ -138,6 +145,8 @@ public interface RetryPolicy {
/** /**
* Specify the types of exceptions for which the {@link RetryPolicy} * Specify the types of exceptions for which the {@link RetryPolicy}
* should not retry a failed operation. * should not retry a failed operation.
* <p>If excluded exception types have already been configured, the supplied
* types will be added to the existing list of excluded types.
* <p>This can be combined with {@link #includes(Class...)} and * <p>This can be combined with {@link #includes(Class...)} and
* {@link #predicate(Predicate)}. * {@link #predicate(Predicate)}.
* @param types the types of exceptions to exclude from the policy * @param types the types of exceptions to exclude from the policy