Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-391: More Javadoc Polishing #394

Merged
merged 1 commit into from
Oct 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions src/main/java/org/springframework/retry/annotation/Backoff.java
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@
long maxDelay() default 0;

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

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

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

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