Document that the maxWaitTime setting on policies only applies when using the Failsafe class

Author: jhalterman

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

@@ -50,6 +50,10 @@ public Bulkhead<R> build() {
   /**
    * Configures the {@code maxWaitTime} to wait for permits to be available. If permits cannot be acquired before the
    * {@code maxWaitTime} is exceeded, then the bulkhead will throw {@link BulkheadFullException}.
+   * <p>
+   * This setting only applies when the resulting Bulkhead is used with the {@link Failsafe} class. It does not apply
+   * when the Bulkhead is used in a standalone way.
+   * </p>
    *
    * @throws NullPointerException if {@code maxWaitTime} is null
    */

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

@@ -50,6 +50,10 @@ public int getMaxConcurrency() {
   /**
    * Returns the max time to wait for permits to be available. If permits cannot be acquired before the max wait time is
    * exceeded, then the bulkhead will throw {@link BulkheadFullException}.
+   * <p>
+   * This setting only applies when the Bulkhead is used with the {@link Failsafe} class. It does not apply when the
+   * Bulkhead is used in a standalone way.
+   * </p>
    *
    * @see BulkheadBuilder#withMaxWaitTime(Duration)
    */

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

@@ -19,7 +19,6 @@
 import dev.failsafe.internal.util.Assert;
 
 import java.time.Duration;
-import java.time.temporal.ChronoUnit;
 
 /**
  * Builds {@link RateLimiter} instances.
@@ -57,6 +56,10 @@ public RateLimiter<R> build() {
   /**
    * Configures the {@code maxWaitTime} to wait for permits to be available. If permits cannot be acquired before the
    * {@code maxWaitTime} is exceeded, then the rate limiter will throw {@link RateLimitExceededException}.
+   * <p>
+   * This setting only applies when the resulting RateLimiter is used with the {@link Failsafe} class. It does not apply
+   * when the RateLimiter is used in a standalone way.
+   * </p>
    *
    * @throws NullPointerException if {@code maxWaitTime} is null
    */

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

@@ -85,6 +85,10 @@ public Duration getPeriod() {
   /**
    * Returns the max time to wait for permits to be available. If permits cannot be acquired before the max wait time is
    * exceeded, then the rate limiter will throw {@link RateLimitExceededException}.
+   * <p>
+   * This setting only applies when the RateLimiter is used with the {@link Failsafe} class. It does not apply when the
+   * RateLimiter is used in a standalone way.
+   * </p>
    *
    * @see RateLimiterBuilder#withMaxWaitTime(Duration)
    */