Skip to content

Commit 9ed1796

Browse files
rla124fmbenhassine
authored andcommitted
Clarify Javadoc for skipLimit with custom SkipPolicy
Resolves #4963 Signed-off-by: Subin Kim <rla0010101@gmail.com> (cherry picked from commit 82bd3a2)
1 parent 76efee7 commit 9ed1796

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/FaultTolerantStepBuilder.java

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,17 @@ public FaultTolerantStepBuilder<I, O> retryContextCache(RetryContextCache retryC
305305
}
306306

307307
/**
308-
* Sets the maximum number of failed items to skip before the step fails. Ignored if
309-
* an explicit {@link #skipPolicy(SkipPolicy)} is provided.
310-
* @param skipLimit the skip limit to set. Default is 10.
311-
* @return this for fluent chaining
308+
* Sets the maximum number of failed items to skip before the step fails. The default
309+
* value is 10.
310+
* <p>
311+
* This limit is enforced using the default
312+
* {@link org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy}. If a
313+
* custom {@link SkipPolicy} is provided via {@link #skipPolicy(SkipPolicy)}, this
314+
* limit will not be enforced by the step directly, but it can be implemented to be
315+
* honored by the custom policy.
316+
* @param skipLimit the maximum number of failed items to skip.
317+
* @return this for fluent chaining.
318+
* @see SkipPolicy
312319
*/
313320
public FaultTolerantStepBuilder<I, O> skipLimit(int skipLimit) {
314321
this.skipLimit = skipLimit;
@@ -341,6 +348,9 @@ public FaultTolerantStepBuilder<I, O> skip(Class<? extends Throwable> type) {
341348
/**
342349
* Provide an explicit policy for managing skips. A skip policy determines which
343350
* exceptions are skippable and how many times.
351+
* <p>
352+
* Note that setting a custom policy overrides the default limit-checking behavior
353+
* configured via {@link #skipLimit(int)}.
344354
* @param skipPolicy the skip policy
345355
* @return this for fluent chaining
346356
*/

0 commit comments

Comments
 (0)