[FLINK-19001] Add more JavaDoc

apache · Aug 19, 2020 · fb66deb · fb66deb
1 parent 09fa62e
commit fb66deb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/...in/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionDataStreamBuilder.java b/...in/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionDataStreamBuilder.java
@@ -46,6 +46,7 @@
  */
 public final class StatefulFunctionDataStreamBuilder {
 
+  /** Creates a {@code StatefulFunctionDataStreamBuilder}. */
   public static StatefulFunctionDataStreamBuilder builder(String pipelineName) {
     FeedbackKey<Message> key = new FeedbackKey<>(pipelineName, 1);
     return new StatefulFunctionDataStreamBuilder(key);

diff --git a/...c/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java b/...c/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java
@@ -20,12 +20,19 @@
 
 import java.util.Map;
 import java.util.Objects;
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.statefun.sdk.io.EgressIdentifier;
 import org.apache.flink.streaming.api.datastream.DataStream;
 
+/**
+ * StatefulFunctionEgressStreams - this class holds a handle for every egress stream defined via
+ * {@link StatefulFunctionDataStreamBuilder#withEgressId(EgressIdentifier)}. see {@link
+ * #getDataStreamForEgressId(EgressIdentifier)}.
+ */
 public final class StatefulFunctionEgressStreams {
   private final Map<EgressIdentifier<?>, DataStream<?>> egresses;
 
+  @Internal
   StatefulFunctionEgressStreams(Map<EgressIdentifier<?>, DataStream<?>> egresses) {
     this.egresses = Objects.requireNonNull(egresses);
   }
@@ -45,6 +52,7 @@ public final class StatefulFunctionEgressStreams {
    */
   @SuppressWarnings("unchecked")
   public <T> DataStream<T> getDataStreamForEgressId(EgressIdentifier<T> id) {
+    Objects.requireNonNull(id);
     DataStream<?> dataStream = egresses.get(id);
     if (dataStream == null) {
       throw new IllegalArgumentException("Unknown data stream for egress " + id);