You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by al...@apache.org on 2016/11/07 15:26:32 UTC
[4/6] flink git commit: [FLINK-4951] Fix Javadoc of
KeyedStream.flatMap(TimelyFlatMapFunction)
[FLINK-4951] Fix Javadoc of KeyedStream.flatMap(TimelyFlatMapFunction)
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/b9173b35
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/b9173b35
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/b9173b35
Branch: refs/heads/master
Commit: b9173b355139f007fb840aa6a196f50b366ad8d8
Parents: 132d8f1
Author: Aljoscha Krettek <al...@gmail.com>
Authored: Fri Oct 28 12:21:22 2016 +0200
Committer: Aljoscha Krettek <al...@gmail.com>
Committed: Mon Nov 7 16:25:57 2016 +0100
----------------------------------------------------------------------
.../streaming/api/datastream/KeyedStream.java | 25 ++++++++++----------
1 file changed, 13 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/b9173b35/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java
----------------------------------------------------------------------
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java
index 1bce6a2..922ad20 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java
@@ -20,10 +20,8 @@ package org.apache.flink.streaming.api.datastream;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.annotation.Internal;
import org.apache.flink.annotation.Public;
-import org.apache.flink.api.common.functions.FlatMapFunction;
import org.apache.flink.api.common.functions.FoldFunction;
import org.apache.flink.api.common.functions.ReduceFunction;
-import org.apache.flink.api.common.functions.RichFlatMapFunction;
import org.apache.flink.api.common.state.FoldingStateDescriptor;
import org.apache.flink.api.common.state.ListStateDescriptor;
import org.apache.flink.api.common.state.ReducingStateDescriptor;
@@ -175,19 +173,22 @@ public class KeyedStream<T, KEY> extends DataStream<T> {
}
/**
- * Applies a FlatMap transformation on a {@link DataStream}. The
- * transformation calls a {@link FlatMapFunction} for each element of the
- * DataStream. Each FlatMapFunction call can return any number of elements
- * including none. The user can also extend {@link RichFlatMapFunction} to
- * gain access to other features provided by the
+ * Applies the given {@link TimelyFlatMapFunction} on the input stream, thereby
+ * creating a transformed output stream.
+ *
+ * <p>The function will be called for every element in the stream and can produce
+ * zero or more output. The function can also query the time and set timers. When
+ * reacting to the firing of set timers the function can emit yet more elements.
+ *
+ * <p>A {@link org.apache.flink.streaming.api.functions.RichTimelyFlatMapFunction}
+ * can be used to gain access to features provided by the
* {@link org.apache.flink.api.common.functions.RichFunction} interface.
*
- * @param flatMapper
- * The FlatMapFunction that is called for each element of the
- * DataStream
+ * @param flatMapper The {@link TimelyFlatMapFunction} that is called for each element
+ * in the stream.
+ *
+ * @param <R> The of elements emitted by the {@code TimelyFlatMapFunction}.
*
- * @param <R>
- * output type
* @return The transformed {@link DataStream}.
*/
public <R> SingleOutputStreamOperator<R> flatMap(TimelyFlatMapFunction<T, R> flatMapper) {