Improve RetryPolicy javadocs around delays.

Fixes #345.

Author: jhalterman

core/src/main/java/dev/failsafe/RetryPolicyBuilder.java

@@ -148,8 +148,8 @@ public RetryPolicyBuilder<R> abortOn(List<Class<? extends Throwable>> exceptions
   }
 
   /**
-   * Specifies that retries should be aborted if the {@code abortPredicate} matches the exception. Any exception
-   * thrown from the {@code abortPredicate} is treated as a {@code false} result.
+   * Specifies that retries should be aborted if the {@code abortPredicate} matches the exception. Any exception thrown
+   * from the {@code abortPredicate} is treated as a {@code false} result.
    *
    * @throws NullPointerException if {@code abortPredicate} is null
    */
@@ -314,8 +314,8 @@ public RetryPolicyBuilder<R> withBackoff(Duration delay, Duration maxDelay, doub
   }
 
   /**
-   * Sets the {@code delay} to occur between retries. Replaces any previously configured {@link #withBackoff(Duration,
-   * Duration) backoff} or {@link #withDelay(Duration, Duration) random} delays.
+   * Sets the fixed {@code delay} to occur between retries. Replaces any previously configured {@link
+   * #withBackoff(Duration, Duration) backoff} or {@link #withDelay(Duration, Duration) random} delays.
    *
    * @throws NullPointerException if {@code delay} is null
    * @throws IllegalArgumentException if {@code delay} <= 0

core/src/main/java/dev/failsafe/RetryPolicyConfig.java

@@ -96,15 +96,16 @@ public boolean allowsRetries() {
    * @see RetryPolicyBuilder#abortOn(List)
    * @see RetryPolicyBuilder#abortOn(CheckedPredicate)
    * @see RetryPolicyBuilder#abortIf(CheckedBiPredicate)
-   * @see RetryPolicyBuilder#abortIf(CheckedPredicate) 
-   * @see RetryPolicyBuilder#abortWhen(Object) 
+   * @see RetryPolicyBuilder#abortIf(CheckedPredicate)
+   * @see RetryPolicyBuilder#abortWhen(Object)
    */
   public List<CheckedBiPredicate<R, Throwable>> getAbortConditions() {
     return abortConditions;
   }
 
   /**
-   * Returns the delay between retries. Defaults to {@link Duration#ZERO}.
+   * Returns the delay between retries, else {@link Duration#ZERO} if delays have not been configured. If backoff
+   * delays are configured, this value will represent the initial delay.
    *
    * @see RetryPolicyBuilder#withDelay(Duration)
    * @see RetryPolicyBuilder#withBackoff(Duration, Duration, double)
@@ -117,7 +118,7 @@ public Duration getDelay() {
   }
 
   /**
-   * Returns the min delay between retries.
+   * Returns the min random delay between retries, else {@code null} if random delays have not been configured.
    *
    * @see RetryPolicyBuilder#withDelay(Duration, Duration)
    * @see RetryPolicyBuilder#withDelay(long, long, ChronoUnit)
@@ -127,7 +128,7 @@ public Duration getDelayMin() {
   }
 
   /**
-   * Returns the max delay between retries.
+   * Returns the max random delay between retries, else {@code null} if random delays have not been configured.
    *
    * @see RetryPolicyBuilder#withDelay(Duration, Duration)
    * @see RetryPolicyBuilder#withDelay(long, long, ChronoUnit)
@@ -176,7 +177,7 @@ public int getMaxAttempts() {
   }
 
   /**
-   * Returns the max delay between backoff retries.
+   * Returns the max delay between backoff retries, else {@code null} if backoff delays have not been configured.
    *
    * @see RetryPolicyBuilder#withBackoff(Duration, Duration)
    * @see RetryPolicyBuilder#withBackoff(Duration, Duration, double)