[incubator-streampark] branch dev updated: [ISSUE-3114][Improve] Improve streampark-testcontainer module based on [3.7 Code Comments Rule] (#3233)

[benjobs]

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

benjobs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampark.git


The following commit(s) were added to refs/heads/dev by this push:
     new daf9cfd0c [ISSUE-3114][Improve] Improve streampark-testcontainer 
module based on [3.7 Code Comments Rule] (#3233)
daf9cfd0c is described below

commit daf9cfd0cf15728ecb72295ca570cc82487fce86
Author: Yuepeng Pan <flin...@126.com>
AuthorDate: Tue Oct 10 19:39:46 2023 -0500

    [ISSUE-3114][Improve] Improve streampark-testcontainer module based on [3.7 
Code Comments Rule] (#3233)
---
 .../org/apache/streampark/testcontainer/flink/FlinkComponent.java  | 2 ++
 .../org/apache/streampark/testcontainer/flink/FlinkContainer.java  | 4 ++++
 .../testcontainer/flink/FlinkStandaloneSessionCluster.java         | 7 ++++---
 3 files changed, 10 insertions(+), 3 deletions(-)

diff --git 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java
 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java
index 13a62e01f..ebb907690 100644
--- 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java
+++ 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java
@@ -19,8 +19,10 @@ package org.apache.streampark.testcontainer.flink;
 
 import javax.annotation.Nonnull;
 
+/** The enum is used to represent the type of the flink component. */
 enum FlinkComponent {
   JOBMANAGER("jobmanager"),
+
   TASKMANAGER("taskmanager");
 
   private final String name;
diff --git 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java
 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java
index e28028829..822f87b3b 100644
--- 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java
+++ 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java
@@ -31,6 +31,10 @@ import java.util.concurrent.atomic.AtomicInteger;
 import static 
org.apache.streampark.testcontainer.flink.FlinkComponent.JOBMANAGER;
 import static 
org.apache.streampark.testcontainer.flink.FlinkComponent.TASKMANAGER;
 
+/**
+ * The Flink container class. It would be created as a flink jobmanager 
container or a taskmanaager
+ * container. Note: It's an internal class to construct a flink session 
cluster.
+ */
 class FlinkContainer extends GenericContainer<FlinkContainer> {
 
   public static final AtomicInteger TM_INDEX_SUFFIX = new AtomicInteger(0);
diff --git 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java
 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java
index 9c989957b..db5613316 100644
--- 
a/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java
+++ 
b/streampark-tests/streampark-testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java
@@ -38,9 +38,9 @@ import static 
org.apache.streampark.testcontainer.flink.FlinkComponent.JOBMANAGE
 import static 
org.apache.streampark.testcontainer.flink.FlinkComponent.TASKMANAGER;
 
 /**
- * Class to start a couple of flink 1-jobmanager & n-taskmanagers. The 
priority of flinkYamlConfStr
- * is the highest. But: The 'jobmanager.rpc.address' is always 'jobmanager'. 
The 'rest.port' always
- * is 8081.
+ * Class to start a couple of flink 1-jobmanager & n-taskmanagers. The 
priority of
+ * flinkYamlConfContent is the highest. But: The 'jobmanager.rpc.address' is 
always 'jobmanager'.
+ * The 'rest.port' always is 8081.
  */
 public class FlinkStandaloneSessionCluster implements Startable {
 
@@ -137,6 +137,7 @@ public class FlinkStandaloneSessionCluster implements 
Startable {
                 : String.format("%s\n%s\n", this.yamlConfContent, 
yamlConfStr));
   }
 
+  /** A tool class to create a flink standalone session cluster quickly. */
   public static class Builder {
 
     private DockerImageName dockerImageName =