Fix Javadoc

apache · Dec 1, 2024 · 2a416d5 · 2a416d5
1 parent b21d685
commit 2a416d5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 0 deletions.
diff --git a/...-flink-common/src/main/java/org/apache/paimon/flink/sink/AppendCompactWorkerOperator.java b/...-flink-common/src/main/java/org/apache/paimon/flink/sink/AppendCompactWorkerOperator.java
@@ -27,6 +27,7 @@
 import org.apache.paimon.table.sink.CommitMessage;
 import org.apache.paimon.utils.ExecutorThreadFactory;
 
+import org.apache.flink.streaming.api.operators.StreamOperatorFactory;
 import org.apache.flink.streaming.api.operators.StreamOperatorParameters;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -106,6 +107,7 @@ public void close() throws Exception {
         }
     }
 
+    /** {@link StreamOperatorFactory} of {@link AppendCompactWorkerOperator}. */
     protected abstract static class Factory<IN>
             extends PrepareCommitOperator.Factory<IN, Committable> {
         protected final FileStoreTable table;

diff --git a/...paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/PrepareCommitOperator.java b/...paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/PrepareCommitOperator.java
@@ -32,6 +32,7 @@
 import org.apache.flink.streaming.api.operators.OneInputStreamOperator;
 import org.apache.flink.streaming.api.operators.OneInputStreamOperatorFactory;
 import org.apache.flink.streaming.api.operators.Output;
+import org.apache.flink.streaming.api.operators.StreamOperatorFactory;
 import org.apache.flink.streaming.api.operators.StreamOperatorParameters;
 import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
 import org.apache.flink.streaming.runtime.tasks.StreamTask;
@@ -107,6 +108,7 @@ private void emitCommittables(boolean waitCompaction, long checkpointId) throws
     protected abstract List<OUT> prepareCommit(boolean waitCompaction, long checkpointId)
             throws IOException;
 
+    /** {@link StreamOperatorFactory} of {@link PrepareCommitOperator}. */
     protected abstract static class Factory<IN, OUT> extends AbstractStreamOperatorFactory<OUT>
             implements OneInputStreamOperatorFactory<IN, OUT> {
         protected final Options options;

diff --git a/...nk/paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/TableWriteOperator.java b/...nk/paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/TableWriteOperator.java
@@ -28,6 +28,7 @@
 
 import org.apache.flink.runtime.state.StateInitializationContext;
 import org.apache.flink.runtime.state.StateSnapshotContext;
+import org.apache.flink.streaming.api.operators.StreamOperatorFactory;
 import org.apache.flink.streaming.api.operators.StreamOperatorParameters;
 import org.apache.flink.streaming.runtime.streamrecord.RecordAttributes;
 
@@ -131,6 +132,7 @@ public StoreSinkWrite getWrite() {
         return write;
     }
 
+    /** {@link StreamOperatorFactory} of {@link TableWriteOperator}. */
     protected abstract static class Factory<IN>
             extends PrepareCommitOperator.Factory<IN, Committable> {
         protected final FileStoreTable table;

diff --git a/...n-flink-common/src/test/java/org/apache/paimon/flink/sink/WriterChainingStrategyTest.java b/...n-flink-common/src/test/java/org/apache/paimon/flink/sink/WriterChainingStrategyTest.java
@@ -39,6 +39,9 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+/**
+ * Tests for {@link org.apache.flink.streaming.api.operators.ChainingStrategy} of writer operators.
+ */
 public class WriterChainingStrategyTest {
     private static final String TABLE_NAME = "paimon_table";