You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2020/06/24 18:42:51 UTC
[flink] 02/04: [hotfix][DataStream API] Fix checkstyle issues and
JavaDocs in CheckpointListener.
This is an automated email from the ASF dual-hosted git repository.
sewen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit b689cea3c3bcada76dec316ae41054a4a798e4e5
Author: Stephan Ewen <se...@apache.org>
AuthorDate: Wed Jun 24 17:51:22 2020 +0200
[hotfix][DataStream API] Fix checkstyle issues and JavaDocs in CheckpointListener.
---
.../apache/flink/runtime/state/CheckpointListener.java | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointListener.java b/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointListener.java
index ddf2f2d..adc4baf 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointListener.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointListener.java
@@ -15,8 +15,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.flink.runtime.state;
+package org.apache.flink.runtime.state;
import org.apache.flink.annotation.PublicEvolving;
@@ -30,12 +30,13 @@ public interface CheckpointListener {
/**
* This method is called as a notification once a distributed checkpoint has been completed.
- *
- * Note that any exception during this method will not cause the checkpoint to
+ *
+ * <p>Note that any exception during this method will not cause the checkpoint to
* fail any more.
- *
+ *
* @param checkpointId The ID of the checkpoint that has been completed.
- * @throws Exception
+ * @throws Exception This method can propagate exceptions, which leads to a failure/recovery for
+ * the task. Not that this will NOT lead to the checkpoint being revoked.
*/
void notifyCheckpointComplete(long checkpointId) throws Exception;
@@ -43,7 +44,8 @@ public interface CheckpointListener {
* This method is called as a notification once a distributed checkpoint has been aborted.
*
* @param checkpointId The ID of the checkpoint that has been aborted.
- * @throws Exception
+ * @throws Exception This method can propagate exceptions, which leads to a failure/recovery for
+ * the task.
*/
- default void notifyCheckpointAborted(long checkpointId) throws Exception {};
+ default void notifyCheckpointAborted(long checkpointId) throws Exception {}
}