[FLINK-19001] Add additional JavadDocs
diff --git a/statefun-flink/statefun-flink-datastream/src/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java b/statefun-flink/statefun-flink-datastream/src/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java
index e3182a3..2100353 100644
--- a/statefun-flink/statefun-flink-datastream/src/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java
+++ b/statefun-flink/statefun-flink-datastream/src/main/java/org/apache/flink/statefun/flink/datastream/StatefulFunctionEgressStreams.java
@@ -30,11 +30,24 @@
this.egresses = Objects.requireNonNull(egresses);
}
+ /**
+ * Returns the {@link DataStream} that represents a stateful functions egress for an {@link
+ * EgressIdentifier}.
+ *
+ * <p>Messages that are sent to an egress with the supplied id, (via {@link
+ * org.apache.flink.statefun.sdk.Context#send(EgressIdentifier, Object)}) would result in the
+ * {@link DataStream} returned from that method.
+ *
+ * @param id the egress id, as provided to {@link
+ * StatefulFunctionDataStreamBuilder#withEgressId(EgressIdentifier)}.
+ * @param <T> the egress message type.
+ * @return a data stream that represents messages sent to the provided egress.
+ */
@SuppressWarnings("unchecked")
public <T> DataStream<T> getDataStreamForEgressId(EgressIdentifier<T> id) {
DataStream<?> dataStream = egresses.get(id);
if (dataStream == null) {
- throw new IllegalArgumentException("Unknown data stream for ingress " + id);
+ throw new IllegalArgumentException("Unknown data stream for egress " + id);
}
return (DataStream<T>) dataStream;
}
