Skip to content

Commit fe0e890

Browse files
committed
Remove successive from circuitbreaker and retrypolicy javadocs
1 parent 8fe9126 commit fe0e890

File tree

4 files changed

+16
-19
lines changed

4 files changed

+16
-19
lines changed

src/main/java/dev/failsafe/CircuitBreakerBuilder.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ public CircuitBreakerBuilder<R> withFailureThreshold(int failureThreshold) {
137137
}
138138

139139
/**
140-
* Configures count based failure thresholding by setting the ratio of successive failures to executions that must
141-
* occur when in a CLOSED state in order to open the circuit. For example: 5, 10 would open the circuit if 5 out of
142-
* the last 10 executions result in a failure.
140+
* Configures count based failure thresholding by setting the ratio of failures to executions that must occur when in
141+
* a CLOSED state in order to open the circuit. For example: 5, 10 would open the circuit if 5 out of the last 10
142+
* executions result in a failure.
143143
* <p>
144144
* If a {@link #withSuccessThreshold(int) success threshold} is not configured, the {@code failureThreshold} and
145145
* {@code failureThresholdingCapacity} will also be used when the circuit breaker is in a HALF_OPEN state to determine
@@ -281,9 +281,9 @@ public CircuitBreakerBuilder<R> withSuccessThreshold(int successThreshold) {
281281
}
282282

283283
/**
284-
* Configures count based success thresholding by setting the ratio of successive successful executions that must
285-
* occur when in a HALF_OPEN state in order to close the circuit. For example: 5, 10 would close the circuit if 5 out
286-
* of the last 10 executions were successful.
284+
* Configures count based success thresholding by setting the ratio of successful executions that must occur when in a
285+
* HALF_OPEN state in order to close the circuit. For example: 5, 10 would close the circuit if 5 out of the last 10
286+
* executions were successful.
287287
*
288288
* @param successThreshold The number of successful executions that must occur in order to open the circuit
289289
* @param successThresholdingCapacity The capacity for storing execution results when performing success thresholding

src/main/java/dev/failsafe/CircuitBreakerConfig.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public Duration getDelay() {
7575
}
7676

7777
/**
78-
* Gets the number of successive failures that must occur within the {@link #getFailureThresholdingCapacity() failure
78+
* Gets the number of failures that must occur within the {@link #getFailureThresholdingCapacity() failure
7979
* thresholding capacity} when in a CLOSED or HALF_OPEN state in order to open the circuit. Returns {@code 1} by
8080
* default.
8181
*
@@ -136,7 +136,7 @@ public int getFailureExecutionThreshold() {
136136
}
137137

138138
/**
139-
* Gets the number of successive successes that must occur within the {@link #getSuccessThresholdingCapacity() success
139+
* Gets the number of successes that must occur within the {@link #getSuccessThresholdingCapacity() success
140140
* thresholding capacity} when in a HALF_OPEN state in order to open the circuit. Returns {@code 0} by default, in
141141
* which case the {@link #getFailureThreshold() failure threshold} is used instead.
142142
*

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -236,8 +236,8 @@ public RetryPolicyBuilder<R> onRetryScheduled(EventListener<ExecutionScheduledEv
236236

237237
/**
238238
* Sets the {@code delay} between retries, exponentially backing off to the {@code maxDelay} and multiplying
239-
* successive delays by a factor of 2. Replaces any previously configured {@link #withDelay(Duration) fixed} or {@link
240-
* #withDelay(Duration, Duration) random} delays.
239+
* consecutive delays by a factor of 2. Replaces any previously configured {@link #withDelay(Duration) fixed} or
240+
* {@link #withDelay(Duration, Duration) random} delays.
241241
*
242242
* @throws NullPointerException if {@code delay} or {@code maxDelay} are null
243243
* @throws IllegalArgumentException if {@code delay} is <= 0 or {@code delay} is >= {@code maxDelay}
@@ -250,8 +250,8 @@ public RetryPolicyBuilder<R> withBackoff(Duration delay, Duration maxDelay) {
250250

251251
/**
252252
* Sets the {@code delay} between retries, exponentially backing off to the {@code maxDelay} and multiplying
253-
* successive delays by a factor of 2. Replaces any previously configured {@link #withDelay(Duration) fixed} or {@link
254-
* #withDelay(Duration, Duration) random} delays.
253+
* consecutive delays by a factor of 2. Replaces any previously configured {@link #withDelay(Duration) fixed} or
254+
* {@link #withDelay(Duration, Duration) random} delays.
255255
*
256256
* @throws NullPointerException if {@code chronoUnit} is null
257257
* @throws IllegalArgumentException if {@code delay} is <= 0 or {@code delay} is >= {@code maxDelay}
@@ -264,8 +264,8 @@ public RetryPolicyBuilder<R> withBackoff(long delay, long maxDelay, ChronoUnit c
264264

265265
/**
266266
* Sets the {@code delay} between retries, exponentially backing off to the {@code maxDelay} and multiplying
267-
* successive delays by the {@code delayFactor}. Replaces any previously configured {@link #withDelay(Duration) fixed}
268-
* or {@link #withDelay(Duration, Duration) random} delays.
267+
* consecutive delays by the {@code delayFactor}. Replaces any previously configured {@link #withDelay(Duration)
268+
* fixed} or {@link #withDelay(Duration, Duration) random} delays.
269269
*
270270
* @throws NullPointerException if {@code chronoUnit} is null
271271
* @throws IllegalArgumentException if {@code delay} <= 0, {@code delay} is >= {@code maxDelay}, or the {@code
@@ -279,8 +279,8 @@ public RetryPolicyBuilder<R> withBackoff(long delay, long maxDelay, ChronoUnit c
279279

280280
/**
281281
* Sets the {@code delay} between retries, exponentially backing off to the {@code maxDelay} and multiplying
282-
* successive delays by the {@code delayFactor}. Replaces any previously configured {@link #withDelay(Duration) fixed}
283-
* or {@link #withDelay(Duration, Duration) random} delays.
282+
* consecutive delays by the {@code delayFactor}. Replaces any previously configured {@link #withDelay(Duration)
283+
* fixed} or {@link #withDelay(Duration, Duration) random} delays.
284284
*
285285
* @throws NullPointerException if {@code delay} or {@code maxDelay} are null
286286
* @throws IllegalArgumentException if {@code delay} <= 0, {@code delay} is >= {@code maxDelay}, or the {@code

src/test/java/dev/failsafe/CircuitBreakerTest.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@
1717

1818
import org.testng.annotations.Test;
1919

20-
import java.time.Duration;
21-
22-
import static dev.failsafe.testing.Asserts.assertThrows;
2320
import static org.testng.Assert.assertEquals;
2421
import static org.testng.Assert.assertTrue;
2522

0 commit comments

Comments
 (0)