[review] Moves JavaDoc into interface and adds @OverRide annotation

XComp · Jun 27, 2024 · 2e853ce · 2e853ce
1 parent 0cdec92
commit 2e853ce
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/checkpoint/CheckpointStatsTracker.java b/flink-runtime/src/main/java/org/apache/flink/runtime/checkpoint/CheckpointStatsTracker.java
@@ -106,7 +106,16 @@ PendingCheckpointStats reportPendingCheckpoint(
 
     void reportFailedCheckpoint(FailedCheckpointStats failed);
 
+    /**
+     * Callback when a checkpoint failure without in progress checkpoint. For example, it should be
+     * callback when triggering checkpoint failure before creating PendingCheckpoint.
+     */
     void reportFailedCheckpointsWithoutInProgress();
 
+    /**
+     * Creates a new snapshot of the available stats.
+     *
+     * @return The latest statistics snapshot.
+     */
     CheckpointStatsSnapshot createSnapshot();
 }
diff --git a/...time/src/main/java/org/apache/flink/runtime/checkpoint/DefaultCheckpointStatsTracker.java b/...time/src/main/java/org/apache/flink/runtime/checkpoint/DefaultCheckpointStatsTracker.java
@@ -111,11 +111,7 @@ public DefaultCheckpointStatsTracker(
         registerMetrics(metricGroup);
     }
 
-    /**
-     * Creates a new snapshot of the available stats.
-     *
-     * @return The latest statistics snapshot.
-     */
+    @Override
     public CheckpointStatsSnapshot createSnapshot() {
         CheckpointStatsSnapshot snapshot = latestSnapshot;
 
@@ -253,10 +249,7 @@ private void logCheckpointStatistics(AbstractCheckpointStats checkpointStats) {
         }
     }
 
-    /**
-     * Callback when a checkpoint failure without in progress checkpoint. For example, it should be
-     * callback when triggering checkpoint failure before creating PendingCheckpoint.
-     */
+    @Override
     public void reportFailedCheckpointsWithoutInProgress() {
         statsReadWriteLock.lock();
         try {