Align default delay in code to value in document

Fixes gh-146
This commit is contained in:
Zhang Chao
2019-02-18 14:14:43 +08:00
committed by Dave Syer
parent 8bef15de04
commit 2f4386d8b7

View File

@@ -49,7 +49,8 @@ import org.springframework.retry.backoff.BackOffPolicy;
public @interface Backoff {
/**
* Synonym for {@link #delay()}.
* Synonym for {@link #delay()}. When {@link #delay()} is non-zero, value of this element
* is ignored, otherwise value of this element is taken.
*
* @return the delay in milliseconds (default 1000)
*/
@@ -57,8 +58,11 @@ public @interface Backoff {
/**
* A canonical backoff period. Used as an initial value in the exponential case, and
* as a minimum value in the uniform case.
* @return the initial or canonical backoff period in milliseconds (default 1000)
* as a minimum value in the uniform case. When the value of this element is 0,
* value of element {@link #value()} istaken, otherwise value of this
* element is taken and {@link #value()} is ignored.
*
* @return the initial or canonical backoff period in milliseconds (default 0)
*/
long delay() default 0;