Skip to content

Commit 13879ce

Browse files
authored
GH-391: More Javadoc Polishing
Resolves #391
1 parent 6754921 commit 13879ce

File tree

1 file changed

+14
-12
lines changed
  • src/main/java/org/springframework/retry/annotation

1 file changed

+14
-12
lines changed

src/main/java/org/springframework/retry/annotation/Backoff.java

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@
7777
long maxDelay() default 0;
7878

7979
/**
80-
* If positive, then used as a multiplier for generating the next delay for backoff.
80+
* If greater than 1.0, used as a multiplier for generating the next delay for
81+
* backoff; any value less than or equal to 1.0 is treated as 1.0, meaning a fixed
82+
* delay.
8183
* @return a multiplier to use to calculate the next backoff delay (default 0 =
8284
* ignored)
8385
*/
@@ -106,29 +108,29 @@
106108

107109
/**
108110
* Evaluates to a value used as a multiplier for generating the next delay for
109-
* backoff. Overrides {@link #multiplier()}. Use {@code #{...}} for one-time
110-
* evaluation during initialization, omit the delimiters for evaluation at runtime.
111+
* backoff; ; any value less than or equal to 1.0 is treated as 1.0, meaning a fixed
112+
* delay. Overrides {@link #multiplier()}. Use {@code #{...}} for one-time evaluation
113+
* during initialization, omit the delimiters for evaluation at runtime.
111114
* @return a multiplier expression to use to calculate the next backoff delay (default
112115
* 0 = ignored)
113116
* @since 1.2
114117
*/
115118
String multiplierExpression() default "";
116119

117120
/**
118-
* In the exponential case ({@link #multiplier()} > 0 and not equal to 1.0) set
119-
* this to true to have the backoff delays randomized with jitter, so that the maximum
120-
* delay is multiplier times the previous delay and the distribution is uniform
121-
* between the two values.
121+
* In the exponential case ({@link #multiplier()} > 1.0) set this to true to have
122+
* the backoff delays randomized with jitter, so that the maximum delay is multiplier
123+
* times the previous delay and the distribution is uniform between the two values.
122124
* @return the flag to signal randomization is required (default false)
123125
*/
124126
boolean random() default false;
125127

126128
/**
127-
* Evaluates to a value. In the exponential case ({@link #multiplier()} > 0 and not
128-
* equal to 1.0) set this to true to have the backoff delays randomized, so that the
129-
* maximum delay is multiplier times the previous delay and the distribution is
130-
* uniform between the two values. Use {@code #{...}} for one-time evaluation during
131-
* initialization, omit the delimiters for evaluation at runtime.
129+
* Evaluates to a value. In the exponential case ({@link #multiplier()} > 1.0) set
130+
* this to true to have the backoff delays randomized, so that the maximum delay is
131+
* multiplier times the previous delay and the distribution is uniform between the two
132+
* values. Use {@code #{...}} for one-time evaluation during initialization, omit the
133+
* delimiters for evaluation at runtime.
132134
* @return the flag to signal randomization is required (default false)
133135
*/
134136
String randomExpression() default "";

0 commit comments

Comments
 (0)