[flink] 03/03: [hotfix][test] Clarify javadoc exceptions

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mapohl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit b9c5799927b13e70b01e14faa0e467eb6d0a3edc
Author: Ryan Skraba <rs...@apache.org>
AuthorDate: Wed Oct 19 17:55:56 2022 +0200

    [hotfix][test] Clarify javadoc exceptions
---
 .../testutils/junit/extensions/retry/strategy/RetryStrategy.java  | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/retry/strategy/RetryStrategy.java b/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/retry/strategy/RetryStrategy.java
index f6f9adc020a..fa893cb7387 100644
--- a/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/retry/strategy/RetryStrategy.java
+++ b/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/retry/strategy/RetryStrategy.java
@@ -27,11 +27,17 @@ public interface RetryStrategy {
     void stopFollowingAttempts();
 
     /**
-     * Handle the exception after the test execution.
+     * Handle an exception that occurred during the annotated test attempt.
+     *
+     * <p>This method can swallow the exception to pass the test.
      *
      * @param testName the test name
      * @param attemptIndex test attempt index that starts from 1
      * @param throwable the throwable that the test case throws
+     * @throws org.opentest4j.TestAbortedException When handling a test attempt failure, throwing
+     *     this exception indicates another attempt should be made.
+     * @throws Throwable Propagating the original exception, or throwing any other exception
+     *     indicates that the test has definitively failed and no further attempts should be made.
      */
     void handleException(String testName, int attemptIndex, Throwable throwable) throws Throwable;
 }