* This example shows how to run program directly within Java, thus it cannot be used to submit a * {@link backtype.storm.generated.StormTopology} via Flink command line clients (ie, bin/flink). - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * - * Usage:ExclamationLocal <text path> <result path>
+ * Usage: ExclamationLocal <text path> <result path>
* If no parameters are provided, the program is run with default data from
* {@link org.apache.flink.examples.java.wordcount.util.WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: Exclamation[Local|RemoteByClient|RemoteBySubmitter] <text path>
- * <result path>
+ * <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage:
- * ExclamationWithmBolt <text path> <result path> <number of exclamation marks>
+ * ExclamationWithmBolt <text path> <result path> <number of exclamation marks>
* If no parameters are provided, the program is run with default data from {@link WordCountData} with x=2.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * - * Usage:ExclamationWithSpout <text path> <result path>
+ * Usage: ExclamationWithSpout <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* This example shows how to: *
* This example would work the same way for multiple bolt output streams. */ public class SpoutSplitExample { diff --git a/flink-contrib/flink-storm-examples/src/main/java/org/apache/flink/storm/wordcount/BoltTokenizerWordCount.java b/flink-contrib/flink-storm-examples/src/main/java/org/apache/flink/storm/wordcount/BoltTokenizerWordCount.java index aa3a075316ec37338596d9d93d738ba165a9d9f7..6ee7fd9db79b8d58ac6dd9c5d52f35d0cb35e823 100644 --- a/flink-contrib/flink-storm-examples/src/main/java/org/apache/flink/storm/wordcount/BoltTokenizerWordCount.java +++ b/flink-contrib/flink-storm-examples/src/main/java/org/apache/flink/storm/wordcount/BoltTokenizerWordCount.java @@ -30,15 +30,12 @@ import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; /** * Implements the "WordCount" program that computes a simple word occurrence histogram over text files in a streaming * fashion. The tokenizer step is performed by a {@link IRichBolt Bolt}. - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCount <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCount <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCount <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCount <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* This example shows how to run program directly within Java, thus it cannot be used to submit a {@link StormTopology} * via Flink command line clients (ie, bin/flink). - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCountLocal <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* This example shows how to run program directly within Java, thus it cannot be used to submit a {@link StormTopology} * via Flink command line clients (ie, bin/flink). - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCountLocalByName <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* This example shows how to submit the program via Java, thus it cannot be used to submit a {@link StormTopology} via * Flink command line clients (ie, bin/flink). - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCountRemoteByClient <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* This example shows how to submit the program via Java as well as Flink's command line client (ie, bin/flink). - *
- * + ** The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage: WordCountRemoteBySubmitter <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* The input is a plain text file with lines separated by newline characters. - *
- * + *
* Usage:
* WordCount[Local|LocalByName|RemoteByClient|RemoteBySubmitter] <text path> <result path>
* If no parameters are provided, the program is run with default data from {@link WordCountData}.
- *
* This example shows how to: *
* {@link FlinkClient} mimics both, {@link NimbusClient} and {@link Nimbus}{@code .Client}, at once.
*
* @return A reference to itself.
diff --git a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/api/FlinkTopologyBuilder.java b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/api/FlinkTopologyBuilder.java
index 8a88eac939be79d4fbfb2d76f5b7551cf7de86dd..47aa68e17d1d9e6d25d7effeb8bb7814cc5cd402 100644
--- a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/api/FlinkTopologyBuilder.java
+++ b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/api/FlinkTopologyBuilder.java
@@ -55,8 +55,8 @@ import java.util.Set;
/**
* {@link FlinkTopologyBuilder} mimics a {@link TopologyBuilder}, but builds a Flink program instead of a Storm
* topology. Most methods (except {@link #createTopology()} are copied from the original {@link TopologyBuilder}
- * implementation to ensure equal behavior.
* Sets the {@link #isRunning} flag to {@code false}.
*/
@Override
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java
index d88ea34644bfc6a8f74490bec43dc9b52abada7f..8a8f91e6c0843de4c91cc862f8a001728c41d46c 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java
@@ -22,7 +22,7 @@ import java.util.List;
/**
* Entities which have been parsed out of the text of the
- * {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
+ * {@link org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
*/
public class Entities {
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/HashTags.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/HashTags.java
index 1900859999d25928d2930cb28c7db8238e1bfdf3..ba6f5c054344a5b9e4ba5d1311d6f0c630befa94 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/HashTags.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/HashTags.java
@@ -19,7 +19,7 @@ package org.apache.flink.contrib.tweetinputformat.model.tweet.entities;
/**
* Represents hashtags which have been parsed out of the
- * {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet} text.
+ * {@link org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet} text.
*/
public class HashTags {
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Media.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Media.java
index f006aac7ca64c5c597281f9eff7522ef4d56aad1..37d2ab8f2ac005922e8d99d4c1bf5d2f6ab2db7a 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Media.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Media.java
@@ -21,7 +21,7 @@ import java.util.HashMap;
import java.util.Map;
/**
- * Represents media elements uploaded with the {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
+ * Represents media elements uploaded with the {@link org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
*/
public class Media {
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Symbol.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Symbol.java
index db562e8037d5122ba1747274283d9900d1de81cb..c2a6dd02ecba1d259b96ea8770a186b9eaefdf2c 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Symbol.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Symbol.java
@@ -19,7 +19,7 @@ package org.apache.flink.contrib.tweetinputformat.model.tweet.entities;
/**
* An array of financial symbols starting with the dollar sign extracted from the
- * {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet} text.
+ * {@link org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet} text.
*/
public class Symbol {
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/URL.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/URL.java
index 6d0f184ed38c6c1669b657d285b3a53ac57485de..93ddebde1c2cf9a6cbb4685c181f3d2d610bc1ef 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/URL.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/URL.java
@@ -19,7 +19,7 @@ package org.apache.flink.contrib.tweetinputformat.model.tweet.entities;
/**
* Represents URLs included in the text of a Tweet or within textual fields of a
- * {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.User.Users} object.
+ * {@link org.apache.flink.contrib.tweetinputformat.model.tweet.entities.UserMention} object.
*/
public class URL {
diff --git a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/UserMention.java b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/UserMention.java
index a56f7c75e26235991a36fc07c3c323e2863dfa39..2a3cf1aeed3171d18b8fe3876d7ac017ecc7d290 100755
--- a/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/UserMention.java
+++ b/flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/UserMention.java
@@ -19,7 +19,7 @@ package org.apache.flink.contrib.tweetinputformat.model.tweet.entities;
/**
* Represents other Twitter users mentioned in the text of the
- * {@link package org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
+ * {@link org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
*/
public class UserMention {
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/ExecutionConfig.java b/flink-core/src/main/java/org/apache/flink/api/common/ExecutionConfig.java
index f38ecb076d65b3c1ea5c3b86b39601f48cc1dddc..b9ebaf797c1a8b9147f34a0af724f9306779e3e8 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/ExecutionConfig.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/ExecutionConfig.java
@@ -677,7 +677,7 @@ public class ExecutionConfig implements Serializable {
private static final long serialVersionUID = 1L;
/**
- * Convert UserConfig into a Map
* Note: The last bucket's upper bound is actually discarded by many algorithms.
* The last bucket is assumed to hold all values v such that
- * {@code v > getBucketBoundary(n-1, n)}, where n is the number of buckets.
+ * {@code v > getBucketBoundary(n-1, n)}, where n is the number of buckets.
*
* @param bucketNum The number of the bucket for which to get the upper bound.
* @param totalNumBuckets The number of buckets to split the data into.
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/CoGroupFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/CoGroupFunction.java
index 2d7a1d7c5ef67c62fa194cabd7c641035bd001c1..1098341125e771cad66d69610df8122574c94f4d 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/CoGroupFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/CoGroupFunction.java
@@ -28,12 +28,12 @@ import org.apache.flink.util.Collector;
* If a key is present in only one of the two inputs, it may be that one of the groups is empty.
*
* The basic syntax for using CoGoup on two data sets is as follows:
- *
* {@code set1} is here considered the first input, {@code set2} the second input.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/CrossFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/CrossFunction.java
index 0e9d2a599b9712c72423434914c4c261e2abd072..3660e637df35ad5fffdd33e49b11ceacc6510c2c 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/CrossFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/CrossFunction.java
@@ -28,12 +28,12 @@ import java.io.Serializable;
* pair of elements, instead of processing 2-tuples that contain the pairs.
*
* The basic syntax for using Cross on two data sets is as follows:
- *
* {@code set1} is here considered the first input, {@code set2} the second input.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/FilterFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/FilterFunction.java
index 1f21a966bbc5b552aaac57db82d977be4da43bff..1a80cb89909be7097e488ff23b6249de127f0c0a 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/FilterFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/FilterFunction.java
@@ -25,11 +25,11 @@ import java.io.Serializable;
* The predicate decides whether to keep the element, or to discard it.
*
* The basic syntax for using a FilterFunction is as follows:
- *
* IMPORTANT: The system assumes that the function does not
* modify the elements on which the predicate is applied. Violating this assumption
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatJoinFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatJoinFunction.java
index f99aec4fe0ba3c97ce1eb98acc97342ed08bf1e8..c79046b2a0b8945343ebba439dd45bad13951bb9 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatJoinFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatJoinFunction.java
@@ -34,12 +34,12 @@ import java.io.Serializable;
* if their key is not contained in the other data set.
*
* The basic syntax for using Join on two data sets is as follows:
- *
* {@code set1} is here considered the first input, {@code set2} the second input.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatMapFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatMapFunction.java
index 37c6e8357d139ed661d1d05450d0d1e4987be7d7..5b955f758cd9b63d7632cc80f0127f72e63a2ac5 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatMapFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/FlatMapFunction.java
@@ -29,11 +29,11 @@ import java.io.Serializable;
* use the {@link MapFunction}.
*
* The basic syntax for using a FlatMapFunction is as follows:
- *
* The basic syntax for using a FoldFunction is as follows:
- *
* Like all functions, the FoldFunction needs to be serializable, as defined in {@link java.io.Serializable}.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/GroupReduceFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/GroupReduceFunction.java
index befbee3a07eb5e27e1e7f7271c2ac139e1d6748b..36500f62d0af6d2ed6705db8d19e402aaa595448 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/GroupReduceFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/GroupReduceFunction.java
@@ -32,11 +32,11 @@ import org.apache.flink.util.Collector;
* {@link ReduceFunction}.
*
* The basic syntax for using a grouped GroupReduceFunction is as follows:
- *
* The basic syntax for using Join on two data sets is as follows:
- *
* {@code set1} is here considered the first input, {@code set2} the second input.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/MapFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/MapFunction.java
index bbeacc64d118328f2b529c8b9c16a91bb3b15757..45f3d1f604e43f95cf96da0f1799f6d374d859f8 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/MapFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/MapFunction.java
@@ -28,11 +28,11 @@ import java.io.Serializable;
* using the {@link FlatMapFunction}.
*
* The basic syntax for using a MapFunction is as follows:
- *
* The basic syntax for a MapPartitionFunction is as follows:
- *
* The basic syntax for using a grouped ReduceFunction is as follows:
- *
* Like all functions, the ReduceFunction needs to be serializable, as defined in {@link java.io.Serializable}.
*
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/RichGroupReduceFunction.java b/flink-core/src/main/java/org/apache/flink/api/common/functions/RichGroupReduceFunction.java
index 48e27d370f9d59776f0a408509c65c3738749363..b5edc64ac76d08d532d429d2c6f9a5982598d4c6 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/RichGroupReduceFunction.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/RichGroupReduceFunction.java
@@ -49,7 +49,7 @@ public abstract class RichGroupReduceFunction
* This method is only ever invoked when the subclass of {@link RichGroupReduceFunction}
* adds the {@link Combinable} annotation, or if the combinable flag is set when defining
- * the reduceGroup operation via
+ * the reduceGroup operation via
* org.apache.flink.api.java.operators.GroupReduceOperator#setCombinable(boolean).
*
* Since the reduce function will be called on the result of this method, it is important that this
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/io/FileOutputFormat.java b/flink-core/src/main/java/org/apache/flink/api/common/io/FileOutputFormat.java
index 6854268b249d3aa2fcb35ab2171f91c518aa2daa..219877d566c69a77b5de2b30aac301ec2e414c3c 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/io/FileOutputFormat.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/io/FileOutputFormat.java
@@ -51,7 +51,7 @@ public abstract class FileOutputFormat
* A typical example for checking the equality of two elements is the following:
- *
* A typical code example is the following:
- *
* When running locally, local file systems paths can be used.
* However, in a distributed environment HDFS paths must be provided both as input and output.
*/
diff --git a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/graph/PageRankBasic.java b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/graph/PageRankBasic.java
index f05a15da91a92de9066140fc708a97b9426bb9c1..7b051581ee9d9f97945ce2687eaeab52e11f451d 100644
--- a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/graph/PageRankBasic.java
+++ b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/graph/PageRankBasic.java
@@ -53,7 +53,7 @@ import org.apache.flink.examples.java.graph.util.PageRankData;
* For example
- *
+ * implementation to ensure equal behavior.
+ *
* CAUTION: {@link IRichStateSpout StateSpout}s are currently not supported.
*/
public class FlinkTopologyBuilder {
diff --git a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
index a4b5f8ee48329f740ce97c0e26985720e8e8f45b..5056795200d903e600ba2acd47905b4722602d19 100644
--- a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
+++ b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
@@ -20,10 +20,11 @@ package org.apache.flink.storm.util;
import org.apache.flink.streaming.api.datastream.DataStream;
/**
- * Used by {@link org.apache.flink.storm.wrappers.AbstractStormCollector AbstractStormCollector} to wrap
+ * Used by org.apache.flink.storm.wrappers.AbstractStormCollector to wrap
* output tuples if multiple output streams are declared. For this case, the Flink output data stream must be split via
* {@link DataStream#split(org.apache.flink.streaming.api.collector.selector.OutputSelector) .split(...)} using
* {@link StormStreamSelector}.
+ *
*/
public class SplitStreamType
- *
+ * {@code OUT} (see {@link AbstractStormCollector} for supported types).
+ *
* CAUTION: currently, only simple bolts are supported! (ie, bolts that do not use the Storm configuration
* Map or TopologyContext that is provided by the bolt's open(..) method.
* Furthermore, acking and failing of tuples as well as accessing tuple attributes by field names is not supported so
diff --git a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/wrappers/SpoutWrapper.java b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/wrappers/SpoutWrapper.java
index e78dd5c256ade2aa41426600c944391717e7a004..62b36beec2216004ee6911b29b8c4c0ec3f66837 100644
--- a/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/wrappers/SpoutWrapper.java
+++ b/flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/wrappers/SpoutWrapper.java
@@ -38,15 +38,15 @@ import com.google.common.collect.Sets;
/**
* A {@link SpoutWrapper} wraps an {@link IRichSpout} in order to execute it within a Flink Streaming program. It
* takes the spout's output tuples and transforms them into Flink tuples of type {@code OUT} (see
- * {@link SpoutCollector} for supported types).
- *
+ * {@link SpoutCollector} for supported types).
+ *
* Per default, {@link SpoutWrapper} calls the wrapped spout's {@link IRichSpout#nextTuple() nextTuple()} method in
- * an infinite loop.
+ * an infinite loop.
* Alternatively, {@link SpoutWrapper} can call {@link IRichSpout#nextTuple() nextTuple()} for a finite number of
* times and terminate automatically afterwards (for finite input streams). The number of {@code nextTuple()} calls can
* be specified as a certain number of invocations or can be undefined. In the undefined case, {@link SpoutWrapper}
* terminates if no record was emitted to the output collector for the first time during a call to
- * {@link IRichSpout#nextTuple() nextTuple()}.
+ * {@link IRichSpout#nextTuple() nextTuple()}.
* If the given spout implements {@link FiniteSpout} interface and {@link #numberOfInvocations} is not provided or
* is {@code null}, {@link SpoutWrapper} calls {@link IRichSpout#nextTuple() nextTuple()} method until
* {@link FiniteSpout#reachedEnd()} returns true.
@@ -258,7 +258,7 @@ public final class SpoutWrapper{@code
- * DataSet data = ...;
- * DataSet mapped1 = data.map(new MyMapper());
- * DataSet mapped2 = data.map(new AnotherMapper());
- * mapped1.join(mapped2).where(...).equalTo(...);
+ * DataSet data = ...;
+ * DataSet mapped1 = data.map(new MyMapper());
+ * DataSet mapped2 = data.map(new AnotherMapper());
+ * mapped1.join(mapped2).where(...).equalTo(...);
* }
*/
PIPELINED,
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/accumulators/Histogram.java b/flink-core/src/main/java/org/apache/flink/api/common/accumulators/Histogram.java
index f5e959a03f598e7d18d4a1cc235b032d16b6d30e..f587fee598d7aae80be13fab6ea59d34cabbdd2b 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/accumulators/Histogram.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/accumulators/Histogram.java
@@ -23,7 +23,7 @@ import java.util.TreeMap;
/**
* Histogram accumulator, which builds a histogram in a distributed manner.
- * Implemented as a Integer->Integer TreeMap, so that the entries are sorted
+ * Implemented as a Integer->Integer TreeMap, so that the entries are sorted
* according to the values.
*
* This class does not extend to continuous values later, because it makes no
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/aggregators/Aggregator.java b/flink-core/src/main/java/org/apache/flink/api/common/aggregators/Aggregator.java
index 035b591839cf627f29088fdde8b2846feb134727..aabb82f0a57ed971bfdc8dc9bf5304f4cc20d4e5 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/aggregators/Aggregator.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/aggregators/Aggregator.java
@@ -47,7 +47,7 @@ import org.apache.flink.types.Value;
* }
*
* public boolean filter (Double value) {
- * if (value > 1000000.0) {
+ * if (value > 1000000.0) {
* agg.aggregate(1);
* return false
* }
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/distributions/DataDistribution.java b/flink-core/src/main/java/org/apache/flink/api/common/distributions/DataDistribution.java
index 9bf1abf3fe132bdae41bf6d15d168a6c8f6ad30a..ebf13196e60dc7a9657238cce169618cd49b6895 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/distributions/DataDistribution.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/distributions/DataDistribution.java
@@ -39,7 +39,7 @@ public interface DataDistribution extends IOReadableWritable, Serializable {
*
+ * }
*
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ * }
*
* @param
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ * }
*
* @param
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ * }
*
* @param
+ *
{@code
* DataSet
+ * }
*
* @param
+ *
{@code
* DataSet
+ * }
*
+ *
{@code
* DataSet
+ *
*
* The rational behind this method is that elements are typically compared using certain features that
* are extracted from them, (such de-serializing as a subset of fields). When setting the
@@ -113,7 +113,7 @@ public abstract class TypeComparator{@code
* E e1 = ...;
* E e2 = ...;
*
@@ -84,7 +84,7 @@ public abstract class TypeComparator
+ * }
+ *
*
* The rational behind this method is that elements are typically compared using certain features that
* are extracted from them, (such de-serializing as a subset of fields). When setting the
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java b/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
index b64939e002eb4f7b3b66094797b14427956e53b6..d33154849a0f01260d22063195b1c4a08dc13fd4 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
@@ -600,7 +600,7 @@ public final class ConfigConstants {
public static final boolean DEFAULT_FILESYSTEM_OVERWRITE = false;
/**
- * The default behavior for output directory creating (create only directory when parallelism > 1).
+ * The default behavior for output directory creating (create only directory when parallelism > 1).
*/
public static final boolean DEFAULT_FILESYSTEM_ALWAYS_CREATE_DIRECTORY = false;
diff --git a/flink-core/src/main/java/org/apache/flink/core/fs/FileSystem.java b/flink-core/src/main/java/org/apache/flink/core/fs/FileSystem.java
index 185b5f20f8f8831e85066b44a410694b6fab7b85..7dc92c617ff6b8d5d8d6f77e4f9f7c0c8f974f2c 100644
--- a/flink-core/src/main/java/org/apache/flink/core/fs/FileSystem.java
+++ b/flink-core/src/main/java/org/apache/flink/core/fs/FileSystem.java
@@ -162,8 +162,6 @@ public abstract class FileSystem {
*
* @return a reference to the {@link FileSystem} instance for accessing the
* local file system.
- * @throws IOException
- * thrown if a reference to the file system instance could not be obtained
*/
public static FileSystem getLocalFileSystem() {
// this should really never fail.
@@ -485,20 +483,20 @@ public abstract class FileSystem {
/**
* Initializes output directories on local file systems according to the given write mode.
*
- * WriteMode.CREATE & parallel output:
+ * WriteMode.CREATE & parallel output:
* - A directory is created if the output path does not exist.
* - An existing directory is reused, files contained in the directory are NOT deleted.
* - An existing file raises an exception.
*
- * WriteMode.CREATE & NONE parallel output:
+ * WriteMode.CREATE & NONE parallel output:
* - An existing file or directory raises an exception.
*
- * WriteMode.OVERWRITE & parallel output:
+ * WriteMode.OVERWRITE & parallel output:
* - A directory is created if the output path does not exist.
* - An existing directory is reused, files contained in the directory are NOT deleted.
* - An existing file is deleted and replaced by a new directory.
*
- * WriteMode.OVERWRITE & NONE parallel output:
+ * WriteMode.OVERWRITE & NONE parallel output:
* - An existing file or directory (and all its content) is deleted
*
* Files contained in an existing directory are not deleted, because multiple instances of a
@@ -646,19 +644,19 @@ public abstract class FileSystem {
/**
* Initializes output directories on distributed file systems according to the given write mode.
*
- * WriteMode.CREATE & parallel output:
+ * WriteMode.CREATE & parallel output:
* - A directory is created if the output path does not exist.
* - An existing file or directory raises an exception.
*
- * WriteMode.CREATE & NONE parallel output:
+ * WriteMode.CREATE & NONE parallel output:
* - An existing file or directory raises an exception.
*
- * WriteMode.OVERWRITE & parallel output:
+ * WriteMode.OVERWRITE & parallel output:
* - A directory is created if the output path does not exist.
* - An existing directory and its content is deleted and a new directory is created.
* - An existing file is deleted and replaced by a new directory.
*
- * WriteMode.OVERWRITE & NONE parallel output:
+ * WriteMode.OVERWRITE & NONE parallel output:
* - An existing file or directory is deleted and replaced by a new directory.
*
* @param outPath Output path that should be prepared.
diff --git a/flink-core/src/main/java/org/apache/flink/core/memory/MemorySegment.java b/flink-core/src/main/java/org/apache/flink/core/memory/MemorySegment.java
index 31d5563c8ddbbcb7dfac98eab5807279e58fcb83..8d139213b4548b6760fc41fafffef97c5b973b07 100644
--- a/flink-core/src/main/java/org/apache/flink/core/memory/MemorySegment.java
+++ b/flink-core/src/main/java/org/apache/flink/core/memory/MemorySegment.java
@@ -210,7 +210,7 @@ public abstract class MemorySegment {
}
/**
- * Wraps the chunk of the underlying memory located between offset and
+ * Wraps the chunk of the underlying memory located between offset and
* length in a NIO ByteBuffer.
*
* @param offset The offset in the memory segment.
@@ -1220,7 +1220,7 @@ public abstract class MemorySegment {
* @param offset2 Offset of seg2 to start comparing
* @param len Length of the compared memory region
*
- * @return 0 if equal, -1 if seg1 < seg2, 1 otherwise
+ * @return 0 if equal, -1 if seg1 < seg2, 1 otherwise
*/
public final int compare(MemorySegment seg2, int offset1, int offset2, int len) {
while (len >= 8) {
diff --git a/flink-core/src/main/java/org/apache/flink/types/Record.java b/flink-core/src/main/java/org/apache/flink/types/Record.java
index 24ff979f188529738bbaf595ebac0aac2720ce59..8ef972f567818777a02fd15b1885ce8f07b5da71 100644
--- a/flink-core/src/main/java/org/apache/flink/types/Record.java
+++ b/flink-core/src/main/java/org/apache/flink/types/Record.java
@@ -803,7 +803,7 @@ public final class Record implements Value, CopyableValue{@code
* E e1 = ...;
* E e2 = ...;
*
@@ -124,7 +124,7 @@ public abstract class TypeComparator
+ * }startIndex has prefix
+ * @return True, if this StringValue substring, starting at position startIndex has prefix
* as its prefix.
*/
public boolean startsWith(CharSequence prefix, int startIndex) {
@@ -403,7 +403,7 @@ public class StringValue implements NormalizableKeyprefix as its prefix.
*/
public boolean startsWith(CharSequence prefix) {
return startsWith(prefix, 0);
diff --git a/flink-core/src/main/java/org/apache/flink/util/Visitable.java b/flink-core/src/main/java/org/apache/flink/util/Visitable.java
index 49a7866a50712536c6ab11ca424c68f4a65e893a..559cb9636819c04dca8d19d20a4199ae70b97ba5 100644
--- a/flink-core/src/main/java/org/apache/flink/util/Visitable.java
+++ b/flink-core/src/main/java/org/apache/flink/util/Visitable.java
@@ -38,7 +38,7 @@ public interface Visitable
+ *
+ * }
*
* @param visitor The visitor to be called with this object as the parameter.
*
diff --git a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/clustering/KMeans.java b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/clustering/KMeans.java
index 73f90ca12578746349b5913c020e3330b14bbc4b..2db6f65988261db46c368b8852a3961c6014f6ba 100644
--- a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/clustering/KMeans.java
+++ b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/clustering/KMeans.java
@@ -198,7 +198,7 @@ public class KMeans {
// USER FUNCTIONS
// *************************************************************************
- /** Converts a Tuple2{@code
* public void accept(Visitor"1\n2\n12\n42\n63" gives five pages with IDs 1, 2, 12, 42, and 63.
*
- * For example "1 2\n2 12\n1 12\n42 63" gives four (directed) links (1)->(2), (2)->(12), (1)->(12), and (42)->(63).
+ * For example "1 2\n2 12\n1 12\n42 63" gives four (directed) links (1)->(2), (2)->(12), (1)->(12), and (42)->(63).
* For this simple implementation it is required that each page has at least one incoming and one outgoing link (a page can point to itself).
*
- *
+ *
{@code
* SELECT
* c_custkey,
* c_name,
@@ -64,7 +64,7 @@ import org.apache.flink.api.java.ExecutionEnvironment;
* c_acctbal,
* n_name,
* c_address
- *
* Compared to the original TPC-H query this version does not print diff --git a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/TPCHQuery3.java b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/TPCHQuery3.java index 9a6e58c575f3451c126098fc498ba5102aa847f1..a9e47f60e2d5d0347b2f6a1b1772b1fe3b1c79f5 100644 --- a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/TPCHQuery3.java +++ b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/TPCHQuery3.java @@ -42,7 +42,7 @@ import org.apache.flink.api.java.tuple.Tuple4; * This program implements the following SQL equivalent: * *
- *
+ *
{@code
* SELECT
* l_orderkey,
* SUM(l_extendedprice*(1-l_discount)) AS revenue,
@@ -61,7 +61,7 @@ import org.apache.flink.api.java.tuple.Tuple4;
* l_orderkey,
* o_orderdate,
* o_shippriority;
- *
* Compared to the original TPC-H query this version does not sort the result by revenue
diff --git a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/WebLogAnalysis.java b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/WebLogAnalysis.java
index 9425291ef98d34e6feaa6447aafb7f2671db2fb8..79944aec3c41920c90e65cbeccd278de164b0435 100644
--- a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/WebLogAnalysis.java
+++ b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/relational/WebLogAnalysis.java
@@ -35,7 +35,7 @@ import org.apache.flink.examples.java.relational.util.WebLogDataGenerator;
* This program processes web logs and relational data.
* It implements the following relational query:
*
- *
+ *
{@code
* SELECT
* r.pageURL,
* r.pageRank,
@@ -50,13 +50,13 @@ import org.apache.flink.examples.java.relational.util.WebLogDataGenerator;
* WHERE v.destUrl = d.url
* AND v.visitDate < [date]
* );
- *
* Input files are plain text CSV files using the pipe character ('|') as field separator.
* The tables referenced in the query can be generated using the {@link WebLogDataGenerator} and
* have the following schemas
- *
+ *
{@code
* CREATE TABLE Documents (
* url VARCHAR(100) PRIMARY KEY,
* contents TEXT );
@@ -76,7 +76,7 @@ import org.apache.flink.examples.java.relational.util.WebLogDataGenerator;
* languageCode VARCHAR(6),
* searchWord VARCHAR(32),
* duration INT );
- *
* Usage:
* The input is a plain text file with lines separated by newline characters.
@@ -35,7 +35,7 @@ import org.apache.flink.examples.java.wordcount.util.WordCountData;
* This example shows:
* WebLogAnalysis <documents path> <ranks path> <visits path> <result path>
diff --git a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/wordcount/PojoExample.java b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/wordcount/PojoExample.java
index b001d12b7b434814e9e4b08a39c6d94164da7f6c..0a8595f55ba8b9b163e2c498f9fe40eaa3d761ab 100644
--- a/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/wordcount/PojoExample.java
+++ b/flink-examples/flink-java-examples/src/main/java/org/apache/flink/examples/java/wordcount/PojoExample.java
@@ -112,7 +112,7 @@ public class PojoExample {
/**
* Implements the string tokenizer that splits sentences into words as a user-defined
* FlatMapFunction. The function takes a line (String) and splits it into
- * multiple pairs in the form of "(word,1)" (Tuple2
*
* Call {@link org.apache.flink.api.java.operators.CrossOperator.DefaultCross#with(org.apache.flink.api.common.functions.CrossFunction)} to define a
* {@link org.apache.flink.api.common.functions.CrossFunction} which is called for
- * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
* Call {@link org.apache.flink.api.java.operators.CrossOperator.DefaultCross#with(org.apache.flink.api.common.functions.CrossFunction)} to define a
* {@link org.apache.flink.api.common.functions.CrossFunction} which is called for
- * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
* Call {@link org.apache.flink.api.java.operators.CrossOperator.DefaultCross#with(org.apache.flink.api.common.functions.CrossFunction)} to define a
* {@link org.apache.flink.api.common.functions.CrossFunction} which is called for
- * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
* All annotations take Strings with expressions that refer to (nested) value fields of the input and output types of a function.
@@ -84,17 +84,17 @@ public class FunctionAnnotation {
*
* Fields that are forwarded at the same position can be specified by their position.
* The specified position must be valid for the input and output data type and have the same type.
- * For example
* The resulting {@link DefaultJoin} wraps each pair of joining elements into a {@link Tuple2}, with
* the element of the first input being the first field of the tuple and the element of the
* second input being the second field of the tuple.
@@ -936,8 +936,8 @@ public abstract class JoinOperator
* The resulting {@link DefaultJoin} wraps each pair of joining elements into a {@link Tuple2}, with
* the element of the first input being the first field of the tuple and the element of the
* second input being the second field of the tuple.
@@ -951,10 +951,10 @@ public abstract class JoinOperator
* The resulting {@link DefaultJoin} wraps each pair of joining elements into a {@link Tuple2}, with
* the element of the first input being the first field of the tuple and the element of the
* second input being the second field of the tuple.
@@ -1143,9 +1143,9 @@ public abstract class JoinOperator
- * Multiple forwarded fields can be annotated in one (
- * Multiple forwarded fields can be annotated in one (
- * Multiple forwarded fields can be annotated in one (
* NOTE: Sample with fixed size is not as efficient as sample with fraction, use sample with
* fraction unless you need exact precision.
- *
* NOTE: Sample with fixed size is not as efficient as sample with fraction, use sample with
* fraction unless you need exact precision.
- *
- *
* Compared to the original TPC-H query this version does not print
diff --git a/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/Graph.java b/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/Graph.java
index 68bfb5b4578e33d171de9ee1b509f676df6629db..4f603f7bb70ebd8e1f8dae14486afb9ee1b58bf6 100755
--- a/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/Graph.java
+++ b/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/Graph.java
@@ -352,10 +352,10 @@ public class Graph
+ * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
*
* @param other The other DataSet with which this DataSet is crossed.
* @return A DefaultCross that returns a Tuple2 for each pair of crossed elements.
@@ -1021,7 +1021,7 @@ public abstract class DataSet
+ * Initiates a Cross transformation.
* A Cross transformation combines the elements of two
* {@link DataSet DataSets} into one DataSet. It builds all pair combinations of elements of
* both DataSets, i.e., it builds a Cartesian product.
@@ -1036,7 +1036,7 @@ public abstract class DataSet
+ * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
*
* @param other The other DataSet with which this DataSet is crossed.
* @return A DefaultCross that returns a Tuple2 for each pair of crossed elements.
@@ -1051,7 +1051,7 @@ public abstract class DataSet
+ * Initiates a Cross transformation.
* A Cross transformation combines the elements of two
* {@link DataSet DataSets} into one DataSet. It builds all pair combinations of elements of
* both DataSets, i.e., it builds a Cartesian product.
@@ -1066,7 +1066,7 @@ public abstract class DataSet
+ * each pair of crossed elements. The CrossFunction returns a exactly one element for each pair of input elements.
*
* @param other The other DataSet with which this DataSet is crossed.
* @return A DefaultCross that returns a Tuple2 for each pair of crossed elements.
@@ -1343,7 +1343,7 @@ public abstract class DataSet
+ * Writes a DataSet as a text file to the specified location.
* For each element of the DataSet the result of {@link Object#toString()} is written.
*
* @param filePath The path pointing to the location the text file is written to.
@@ -1356,7 +1356,7 @@ public abstract class DataSet
+ * Writes a DataSet as a text file to the specified location.
* For each element of the DataSet the result of {@link Object#toString()} is written.
*
* @param filePath The path pointing to the location the text file is written to.
@@ -1372,7 +1372,7 @@ public abstract class DataSet
+ * Writes a DataSet as a text file to the specified location.
* For each element of the DataSet the result of {@link TextFormatter#format(Object)} is written.
*
* @param filePath The path pointing to the location the text file is written to.
@@ -1386,7 +1386,7 @@ public abstract class DataSet
+ * Writes a DataSet as a text file to the specified location.
* For each element of the DataSet the result of {@link TextFormatter#format(Object)} is written.
*
* @param filePath The path pointing to the location the text file is written to.
@@ -1401,10 +1401,10 @@ public abstract class DataSet
- * Note: Only a Tuple DataSet can written as a CSV file.
+ * Writes a {@link Tuple} DataSet as a CSV file to the specified location.
+ * Note: Only a Tuple DataSet can written as a CSV file.
* For each Tuple field the result of {@link Object#toString()} is written.
- * Tuple fields are separated by the default field delimiter {@code "comma" (,)}.
+ * Tuple fields are separated by the default field delimiter {@code "comma" (,)}.
* Tuples are are separated by the newline character ({@code \n}).
*
* @param filePath The path pointing to the location the CSV file is written to.
@@ -1418,10 +1418,10 @@ public abstract class DataSet
- * Note: Only a Tuple DataSet can written as a CSV file.
+ * Writes a {@link Tuple} DataSet as a CSV file to the specified location.
+ * Note: Only a Tuple DataSet can written as a CSV file.
* For each Tuple field the result of {@link Object#toString()} is written.
- * Tuple fields are separated by the default field delimiter {@code "comma" (,)}.
+ * Tuple fields are separated by the default field delimiter {@code "comma" (,)}.
* Tuples are are separated by the newline character ({@code \n}).
*
* @param filePath The path pointing to the location the CSV file is written to.
@@ -1436,8 +1436,8 @@ public abstract class DataSet
- * Note: Only a Tuple DataSet can written as a CSV file.
+ * Writes a {@link Tuple} DataSet as a CSV file to the specified location with the specified field and line delimiters.
+ * Note: Only a Tuple DataSet can written as a CSV file.
* For each Tuple field the result of {@link Object#toString()} is written.
*
* @param filePath The path pointing to the location the CSV file is written to.
@@ -1452,9 +1452,9 @@ public abstract class DataSet
- * Note: Only a Tuple DataSet can written as a CSV file.
- * For each Tuple field the result of {@link Object#toString()} is written.
+ * Writes a {@link Tuple} DataSet as a CSV file to the specified location with the specified field and line delimiters.
+ * Note: Only a Tuple DataSet can written as a CSV file.
+§ * For each Tuple field the result of {@link Object#toString()} is written.
*
* @param filePath The path pointing to the location the CSV file is written to.
* @param rowDelimiter The row delimiter to separate Tuples.
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/Utils.java b/flink-java/src/main/java/org/apache/flink/api/java/Utils.java
index 45a14a32953b56a312e102b8c3a67341c8030b6f..bf9ca4c8ca9598365fed3ee892f78942f9fd1977 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/Utils.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/Utils.java
@@ -63,7 +63,6 @@ public final class Utils {
* Returns all GenericTypeInfos contained in a composite type.
*
* @param typeInfo
- * @return
*/
public static void getContainedGenericTypes(CompositeType typeInfo, List
+ * }
*
*
- * \@ForwardedFields({"f0; f1->f2"})
+ *
{@code
+ * {@literal @}ForwardedFields({"f0; f1->f2"})
* public class MyMapper extends MapFunction\@ForwardedFields({"f2"}) declares that the third field of a Java input tuple is
+ * For example {@code {@literal @}ForwardedFields({"f2"})} declares that the third field of a Java input tuple is
* copied to the third field of an output tuple.
*
* Fields which are unchanged copied to another position in the output are declared by specifying the
* source field expression in the input and the target field expression in the output.
- * \@ForwardedFields({"f0->f2"}) denotes that the first field of the Java input tuple is
+ * {@code {@literal @}ForwardedFields({"f0->f2"})} denotes that the first field of the Java input tuple is
* unchanged copied to the third field of the Java output tuple. When using the wildcard ("*") ensure that
* the number of declared fields and their types in input and output type match.
*
- * Multiple forwarded fields can be annotated in one (\@ForwardedFields({"f2; f3->f0; f4"}))
- * or separate Strings (\@ForwardedFields({"f2", "f3->f0", "f4"})).
+ * Multiple forwarded fields can be annotated in one ({@code {@literal @}ForwardedFields({"f2; f3->f0; f4"})})
+ * or separate Strings ({@code {@literal @}ForwardedFields({"f2", "f3->f0", "f4"})}).
*
* NOTE: The use of the ForwardedFields annotation is optional.
* If used correctly, it can help the Flink optimizer to generate more efficient execution plans.
@@ -119,17 +119,17 @@ public class FunctionAnnotation {
*
* Fields that are forwarded from the first input at the same position in the output can be
* specified by their position. The specified position must be valid for the input and output data type and have the same type.
- * For example \@ForwardedFieldsFirst({"f2"}) declares that the third field of a Java input tuple at the first input is
+ * For example {@code {@literal @}ForwardedFieldsFirst({"f2"})} declares that the third field of a Java input tuple at the first input is
* copied to the third field of an output tuple.
*
* Fields which are unchanged copied to another position in the output are declared by specifying the
* source field expression in the input and the target field expression in the output.
- * \@ForwardedFieldsFirst({"f0->f2"}) denotes that the first field of the Java input tuple at the first input is
+ * {@code {@literal @}ForwardedFieldsFirst({"f0->f2"})} denotes that the first field of the Java input tuple at the first input is
* unchanged copied to the third field of the Java output tuple. When using the wildcard ("*") ensure that
* the number of declared fields and their types in input and output type match.
*
- * Multiple forwarded fields can be annotated in one (\@ForwardedFieldsFirst({"f2; f3->f0; f4"}))
- * or separate Strings (\@ForwardedFieldsFirst({"f2", "f3->f0", "f4"})).
+ * Multiple forwarded fields can be annotated in one ({@code {@literal @}ForwardedFieldsFirst({"f2; f3->f0; f4"})})
+ * or separate Strings ({@code {@literal @}ForwardedFieldsFirst({"f2", "f3->f0", "f4"})}).
*
* NOTE: The use of the ForwardedFieldsFirst annotation is optional.
* If used correctly, it can help the Flink optimizer to generate more efficient execution plans.
@@ -157,17 +157,17 @@ public class FunctionAnnotation {
*
* Fields that are forwarded from the second input at the same position in the output can be
* specified by their position. The specified position must be valid for the input and output data type and have the same type.
- * For example \@ForwardedFieldsSecond({"f2"}) declares that the third field of a Java input tuple at the second input is
+ * For example {@code {@literal @}ForwardedFieldsSecond({"f2"})} declares that the third field of a Java input tuple at the second input is
* copied to the third field of an output tuple.
*
* Fields which are unchanged copied to another position in the output are declared by specifying the
* source field expression in the input and the target field expression in the output.
- * \@ForwardedFieldsSecond({"f0->f2"}) denotes that the first field of the Java input tuple at the second input is
+ * {@code {@literal @}ForwardedFieldsSecond({"f0->f2"})} denotes that the first field of the Java input tuple at the second input is
* unchanged copied to the third field of the Java output tuple. When using the wildcard ("*") ensure that
* the number of declared fields and their types in input and output type match.
*
- * Multiple forwarded fields can be annotated in one (\@ForwardedFieldsSecond({"f2; f3->f0; f4"}))
- * or separate Strings (\@ForwardedFieldsSecond({"f2", "f3->f0", "f4"})).
+ * Multiple forwarded fields can be annotated in one ({@code {@literal @}ForwardedFieldsSecond({"f2; f3->f0; f4"})})
+ * or separate Strings ({@code {@literal @}ForwardedFieldsSecond({"f2", "f3->f0", "f4"})}).
*
* NOTE: The use of the ForwardedFieldsSecond annotation is optional.
* If used correctly, it can help the Flink optimizer to generate more efficient execution plans.
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/hadoop/mapred/HadoopInputFormat.java b/flink-java/src/main/java/org/apache/flink/api/java/hadoop/mapred/HadoopInputFormat.java
index 126b629b0dd1921b2f359097380765bedc93c8cb..967f8c4c4d8d2f144a910b72e733adbce6c2a751 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/hadoop/mapred/HadoopInputFormat.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/hadoop/mapred/HadoopInputFormat.java
@@ -30,7 +30,7 @@ import org.apache.hadoop.mapred.JobConf;
/**
* Wrapper for using HadoopInputFormats (mapred-variant) with Flink.
*
- * The IF is returning a Tuple2
* To continue the CoGroup transformation, select the grouping key of the first input {@link DataSet} by calling
* {@link org.apache.flink.api.java.operators.CoGroupOperator.CoGroupOperatorSets#where(int...)} or {@link org.apache.flink.api.java.operators.CoGroupOperator.CoGroupOperatorSets#where(KeySelector)}.
*
@@ -442,9 +442,9 @@ public class CoGroupOperator
- * Note: Fields can only be selected as grouping keys on Tuple DataSets.
+ * Continues a CoGroup transformation.
+ * Defines the {@link Tuple} fields of the first co-grouped {@link DataSet} that should be used as grouping keys.
+ * Note: Fields can only be selected as grouping keys on Tuple DataSets.
*
*
* @param fields The indexes of the Tuple fields of the first co-grouped DataSets that should be used as keys.
@@ -459,7 +459,7 @@ public class CoGroupOperator
* Defines the fields of the first co-grouped {@link DataSet} that should be used as grouping keys. Fields
* are the names of member fields of the underlying type of the data set.
*
@@ -476,9 +476,9 @@ public class CoGroupOperator
* The KeySelector function is called for each element of the first DataSet and extracts a single
- * key value on which the DataSet is grouped.
+ * key value on which the DataSet is grouped.
*
* @param keyExtractor The KeySelector function which extracts the key values from the DataSet on which it is grouped.
* @return An incomplete CoGroup transformation.
@@ -495,7 +495,7 @@ public class CoGroupOperator
* To continue the CoGroup transformation, select the grouping key of the second input {@link DataSet} by calling
* {@link org.apache.flink.api.java.operators.CoGroupOperator.CoGroupOperatorSets.CoGroupOperatorSetsPredicate#equalTo(int...)} or {@link org.apache.flink.api.java.operators.CoGroupOperator.CoGroupOperatorSets.CoGroupOperatorSetsPredicate#equalTo(KeySelector)}.
*
@@ -518,8 +518,8 @@ public class CoGroupOperator
+ * {@link DataSet} that should be used as grouping keys.
+ * Note: Fields can only be selected as grouping keys on Tuple DataSets.
*
*
* @param fields The indexes of the Tuple fields of the second co-grouped DataSet that should be used as keys.
@@ -532,7 +532,7 @@ public class CoGroupOperator
*
*
* @param fields The fields of the first co-grouped DataSets that should be used as keys.
@@ -544,9 +544,9 @@ public class CoGroupOperator
* The KeySelector function is called for each element of the second DataSet and extracts a single
- * key value on which the DataSet is grouped.
+ * key value on which the DataSet is grouped.
*
* @param keyExtractor The KeySelector function which extracts the key values from the second DataSet on which it is grouped.
* @return An incomplete CoGroup transformation.
@@ -558,7 +558,7 @@ public class CoGroupOperator
* To continue the CoGroup transformation, provide a {@link org.apache.flink.api.common.functions.RichCoGroupFunction} by calling
* {@link org.apache.flink.api.java.operators.CoGroupOperator.CoGroupOperatorSets.CoGroupOperatorSetsPredicate.CoGroupOperatorWithoutFunction#with(org.apache.flink.api.common.functions.CoGroupFunction)}.
*
@@ -634,7 +634,7 @@ public class CoGroupOperator
* Each CoGroupFunction call returns an arbitrary number of keys.
*
* @param function The CoGroupFunction that is called for all groups of elements with identical keys.
@@ -660,8 +660,8 @@ public class CoGroupOperator
+ * specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple elements and Pojos can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortFirstGroup(int, Order)} calls.
*
* @param field The Tuple field on which the group is sorted.
@@ -690,8 +690,8 @@ public class CoGroupOperator
+ * specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple elements and Pojos can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortSecondGroup(int, Order)} calls.
*
* @param field The Tuple field on which the group is sorted.
@@ -720,7 +720,7 @@ public class CoGroupOperator
* Groups can be sorted by multiple fields by chaining {@link #sortFirstGroup(String, Order)} calls.
*
* @param fieldExpression The expression to the field on which the group is to be sorted.
@@ -745,7 +745,7 @@ public class CoGroupOperator
* Groups can be sorted by multiple fields by chaining {@link #sortSecondGroup(String, Order)} calls.
*
* @param fieldExpression The expression to the field on which the group is to be sorted.
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/CrossOperator.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/CrossOperator.java
index ae990ceae0c53dc16a119d7220adc13164da28c5..17cd423eecacea5fb1ebf9b7af391a1f635ce92b 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/CrossOperator.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/CrossOperator.java
@@ -108,7 +108,7 @@ public class CrossOperator
* It also represents the {@link DataSet} that is the result of a Cross transformation.
*
* @param
* Each CrossFunction call returns exactly one element.
*
* @param function The CrossFunction that is called for each pair of crossed elements.
@@ -157,9 +157,9 @@ public class CrossOperator
* If the first cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the first cross input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.ProjectCross#projectFirst(int...)} and
@@ -182,9 +182,9 @@ public class CrossOperator
* If the second cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the second cross input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.ProjectCross#projectFirst(int...)} and
@@ -210,7 +210,7 @@ public class CrossOperator
* It also represents the {@link DataSet} that is the result of a Cross transformation.
*
* @param
* If the first cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the first cross input is not a Tuple DataSet, no parameters should be passed.
*
* Additional fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.ProjectCross#projectFirst(int...)} and
@@ -277,9 +277,9 @@ public class CrossOperator
* If the second cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the second cross input is not a Tuple DataSet, no parameters should be passed.
*
* Additional fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.ProjectCross#projectFirst(int...)} and
@@ -493,9 +493,9 @@ public class CrossOperator
* If the first cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the first cross input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.CrossProjection#projectFirst(int...)} and
@@ -559,9 +559,9 @@ public class CrossOperator
* If the second cross input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second cross input is not a Tuple DataSet, no parameters should be passed.
+ * If the second cross input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.CrossOperator.CrossProjection#projectFirst(int...)} and
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/DataSink.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/DataSink.java
index 5b5b03109580fa19c8891d1cea6a3ad66a0b377e..48209cf3c0733c0ae612c81ea752d5fe810800fa 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/DataSink.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/DataSink.java
@@ -95,8 +95,8 @@ public class DataSink
+ * on the specified field in the specified {@link Order} before it is emitted by the output format.
+ * Note: Only tuple data sets can be sorted using integer field indices.
* The tuple data set can be sorted on multiple fields in different orders
* by chaining {@link #sortLocalOutput(int, Order)} calls.
*
@@ -149,9 +149,9 @@ public class DataSink
* Note: Non-composite types can only be sorted on the full element which is specified by
- * a wildcard expression ("*" or "_").
+ * a wildcard expression ("*" or "_").
* Data sets of composite types (Tuple or Pojo) can be sorted on multiple fields in different orders
* by chaining {@link #sortLocalOutput(String, Order)} calls.
*
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/Grouping.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/Grouping.java
index 3c0d07fe14a4cf9938078914756bc006bc5874dc..59811b6537b97dea006047b4e2ff9b09970e1bd9 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/Grouping.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/Grouping.java
@@ -23,7 +23,7 @@ import org.apache.flink.api.common.functions.Partitioner;
import org.apache.flink.api.java.DataSet;
/**
- * Grouping is an intermediate step for a transformation on a grouped DataSet.
+ * Grouping is an intermediate step for a transformation on a grouped DataSet.
* The following transformation can be applied on Grouping:
*
*
* It also represents the {@link DataSet} that is the result of a Join transformation.
*
* @param
* It also represents the {@link DataSet} that is the result of a Join transformation.
*
* @param
* Each JoinFunction call returns exactly one element.
*
* @param function The JoinFunction that is called for each pair of joined elements.
@@ -587,9 +587,9 @@ public abstract class JoinOperator
* If the first join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first join input is not a Tuple DataSet, no parameters should be passed.
+ * If the first join input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.ProjectJoin#projectFirst(int...)} and
@@ -613,9 +613,9 @@ public abstract class JoinOperator
* If the second join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second join input is not a Tuple DataSet, no parameters should be passed.
+ * If the second join input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.ProjectJoin#projectFirst(int...)} and
@@ -657,7 +657,7 @@ public abstract class JoinOperator
* It also represents the {@link DataSet} that is the result of a Join transformation.
*
* @param
* If the first join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first join input is not a Tuple DataSet, no parameters should be passed.
+ * If the first join input is not a Tuple DataSet, no parameters should be passed.
*
* Additional fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.ProjectJoin#projectFirst(int...)} and
@@ -720,9 +720,9 @@ public abstract class JoinOperator
* If the second join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second join input is not a Tuple DataSet, no parameters should be passed.
+ * If the second join input is not a Tuple DataSet, no parameters should be passed.
*
* Additional fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.ProjectJoin#projectFirst(int...)} and
@@ -846,7 +846,7 @@ public abstract class JoinOperator
* To continue the Join transformation, select the join key of the first input {@link DataSet} by calling
* {@link JoinOperatorSets#where(int...)} or
* {@link JoinOperatorSets#where(org.apache.flink.api.java.functions.KeySelector)}.
@@ -906,7 +906,7 @@ public abstract class JoinOperator
* To continue the Join transformation, select the join key of the second input {@link DataSet} by calling
* {@link org.apache.flink.api.java.operators.JoinOperator.JoinOperatorSets.JoinOperatorSetsPredicate#equalTo(int...)} or
* {@link org.apache.flink.api.java.operators.JoinOperator.JoinOperatorSets.JoinOperatorSetsPredicate#equalTo(KeySelector)}.
@@ -919,9 +919,9 @@ public abstract class JoinOperator
- *
+ * {@link DataSet} that should be used as join keys.
+ * Note: Fields can only be selected as join keys on Tuple DataSets.
+ *
+ *
* The KeySelector function is called for each element of the second DataSet and extracts a single
- * key value on which the DataSet is joined.
- *
+ * key value on which the DataSet is joined.
+ *
* If the first join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the first join input is not a Tuple DataSet, no parameters should be passed.
+ * If the first join input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.JoinProjection#projectFirst(int...)} and
@@ -1207,9 +1207,9 @@ public abstract class JoinOperator
* If the second join input is a {@link Tuple} {@link DataSet}, fields can be selected by their index.
- * If the second join input is not a Tuple DataSet, no parameters should be passed.
+ * If the second join input is not a Tuple DataSet, no parameters should be passed.
*
* Fields of the first and second input can be added by chaining the method calls of
* {@link org.apache.flink.api.java.operators.JoinOperator.JoinProjection#projectFirst(int...)} and
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/SingleInputUdfOperator.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/SingleInputUdfOperator.java
index 9301e1ad94f6228a575455754793498c1b07c2e5..63fb804feff3235fbf2bcde6a8843af8256b168a 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/SingleInputUdfOperator.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/SingleInputUdfOperator.java
@@ -125,14 +125,14 @@ public abstract class SingleInputUdfOperatorwithForwardedFields("f0->f2") denotes that the first field of the Java input tuple is
+ * {@code withForwardedFields("f0->f2")} denotes that the first field of the Java input tuple is
* unchanged copied to the third field of the Java output tuple. When using a wildcard ("*") ensure that
* the number of declared fields and their types in input and output type match.
* withForwardedFields("f2; f3->f0; f4"))
- * or separate Strings (withForwardedFields("f2", "f3->f0", "f4")).
+ * Multiple forwarded fields can be annotated in one ({@code withForwardedFields("f2; f3->f0; f4")})
+ * or separate Strings ({@code withForwardedFields("f2", "f3->f0", "f4")}).
* Please refer to the JavaDoc of {@link org.apache.flink.api.common.functions.Function} or Flink's documentation for
* details on field references such as nested fields and wildcard.
*
+ * SortedGrouping is an intermediate step for a transformation on a grouped and sorted DataSet.
* The following transformation can be applied on sorted groups:
*
*
+ * Applies a GroupReduce transformation on a grouped and sorted {@link DataSet}.
* The transformation calls a {@link org.apache.flink.api.common.functions.RichGroupReduceFunction} for each group of the DataSet.
* A GroupReduceFunction can iterate over all elements of a group and emit any
* number of output elements including none.
@@ -189,7 +189,7 @@ public class SortedGrouping
+ * Returns a new set containing the first n elements in this grouped and sorted {@link DataSet}.
* @param n The desired number of elements for each group.
* @return A GroupReduceOperator that represents the DataSet containing the elements.
*/
@@ -206,8 +206,8 @@ public class SortedGrouping
+ * Sorts {@link org.apache.flink.api.java.tuple.Tuple} elements within a group on the specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple or Pojo elements can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortGroup(int, Order)} calls.
*
* @param field The Tuple field on which the group is sorted.
@@ -235,8 +235,8 @@ public class SortedGrouping
+ * Sorts {@link org.apache.flink.api.java.tuple.Tuple} or POJO elements within a group on the specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple or Pojo elements can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortGroup(String, Order)} calls.
*
* @param field The Tuple or Pojo field on which the group is sorted.
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/TwoInputUdfOperator.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/TwoInputUdfOperator.java
index d23dd564272f17d869e2656ed770b62971ecf60c..55a83439f31d305fe728423ebae83dcd6d00377d 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/TwoInputUdfOperator.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/TwoInputUdfOperator.java
@@ -127,14 +127,14 @@ public abstract class TwoInputUdfOperatorwithForwardedFieldsFirst("f0->f2") denotes that the first field of the first input Java tuple is
+ * {@code withForwardedFieldsFirst("f0->f2")} denotes that the first field of the first input Java tuple is
* unchanged copied to the third field of the Java output tuple. When using a wildcard ("*") ensure that
* the number of declared fields and their types in first input and output type match.
* withForwardedFieldsFirst("f2; f3->f0; f4"))
- * or separate Strings (withForwardedFieldsFirst("f2", "f3->f0", "f4")).
+ * Multiple forwarded fields can be annotated in one ({@code withForwardedFieldsFirst("f2; f3->f0; f4")})
+ * or separate Strings ({@code withForwardedFieldsFirst("f2", "f3->f0", "f4")}).
* Please refer to the JavaDoc of {@link org.apache.flink.api.common.functions.Function} or Flink's documentation for
* details on field references such as nested fields and wildcard.
* withForwardedFieldsSecond("f0->f2") denotes that the first field of the second input Java tuple is
+ * {@code withForwardedFieldsSecond("f0->f2")} denotes that the first field of the second input Java tuple is
* unchanged copied to the third field of the Java output tuple. When using a wildcard ("*") ensure that
* the number of declared fields and their types in second input and output type match.
* withForwardedFieldsSecond("f2; f3->f0; f4"))
- * or separate Strings (withForwardedFieldsSecond("f2", "f3->f0", "f4")).
+ * Multiple forwarded fields can be annotated in one ({@code withForwardedFieldsSecond("f2; f3->f0; f4")})
+ * or separate Strings ({@code withForwardedFieldsSecond("f2", "f3->f0", "f4")}).
* Please refer to the JavaDoc of {@link org.apache.flink.api.common.functions.Function} or Flink's documentation for
* details on field references such as nested fields and wildcard.
*
+ * Applies an Aggregate transformation on a grouped {@link org.apache.flink.api.java.tuple.Tuple} {@link DataSet}.
* Note: Only Tuple DataSets can be aggregated.
* The transformation applies a built-in {@link Aggregations Aggregation} on a specified field
* of a Tuple group. Additional aggregation functions can be added to the resulting
@@ -120,7 +120,7 @@ public class UnsortedGrouping
+ * Applies a Reduce transformation on a grouped {@link DataSet}.
* For each group, the transformation consecutively calls a {@link org.apache.flink.api.common.functions.RichReduceFunction}
* until only a single element for each group remains.
* A ReduceFunction combines two elements into one new element of the same type.
@@ -140,7 +140,7 @@ public class UnsortedGrouping
+ * Applies a GroupReduce transformation on a grouped {@link DataSet}.
* The transformation calls a {@link org.apache.flink.api.common.functions.RichGroupReduceFunction} for each group of the DataSet.
* A GroupReduceFunction can iterate over all elements of a group and emit any
* number of output elements including none.
@@ -183,7 +183,7 @@ public class UnsortedGrouping
+ * Returns a new set containing the first n elements in this grouped {@link DataSet}.
* @param n The desired number of elements for each group.
* @return A GroupReduceOperator that represents the DataSet containing the elements.
*/
@@ -196,7 +196,7 @@ public class UnsortedGrouping
+ * Applies a special case of a reduce transformation (minBy) on a grouped {@link DataSet}.
* The transformation consecutively calls a {@link ReduceFunction}
* until only a single element remains which is the result of the transformation.
* A ReduceFunction combines two elements into one new element of the same type.
@@ -217,7 +217,7 @@ public class UnsortedGrouping
+ * Applies a special case of a reduce transformation (maxBy) on a grouped {@link DataSet}.
* The transformation consecutively calls a {@link ReduceFunction}
* until only a single element remains which is the result of the transformation.
* A ReduceFunction combines two elements into one new element of the same type.
@@ -241,8 +241,8 @@ public class UnsortedGrouping
+ * Sorts {@link org.apache.flink.api.java.tuple.Tuple} elements within a group on the specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple elements and Pojos can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortGroup(int, Order)} calls.
*
* @param field The Tuple field on which the group is sorted.
@@ -263,8 +263,8 @@ public class UnsortedGrouping
+ * Sorts Pojos within a group on the specified field in the specified {@link Order}.
+ * Note: Only groups of Tuple elements and Pojos can be sorted.
* Groups can be sorted by multiple fields by chaining {@link #sortGroup(String, Order)} calls.
*
* @param field The Tuple or Pojo field on which the group is sorted.
@@ -285,7 +285,7 @@ public class UnsortedGrouping
* Chaining {@link #sortGroup(KeySelector, Order)} calls is not supported.
*
* @param keySelector The KeySelector with which the group is sorted.
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/join/JoinOperatorSetsBase.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/join/JoinOperatorSetsBase.java
index 6f00cdbd754e0c1c2344ed6ad33ae7e1752ae2e9..e14e06d8ff540892d668eacb9f7f40ab60a81be2 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/join/JoinOperatorSetsBase.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/join/JoinOperatorSetsBase.java
@@ -33,7 +33,7 @@ import org.apache.flink.api.java.tuple.Tuple;
import org.apache.flink.api.java.typeutils.TypeExtractor;
/**
- * Intermediate step of an Outer Join transformation.
+ * Intermediate step of an Outer Join transformation.
* To continue the Join transformation, select the join key of the first input {@link DataSet} by calling
* {@link JoinOperatorSetsBase#where(int...)} or
* {@link JoinOperatorSetsBase#where(KeySelector)}.
@@ -69,9 +69,9 @@ public class JoinOperatorSetsBase
- * Defines the {@link Tuple} fields of the first join {@link DataSet} that should be used as join keys.
- * Note: Fields can only be selected as join keys on Tuple DataSets.
+ * Continues a Join transformation.
+ * Defines the {@link Tuple} fields of the first join {@link DataSet} that should be used as join keys.
+ * Note: Fields can only be selected as join keys on Tuple DataSets.
*
* @param fields The indexes of the other Tuple fields of the first join DataSets that should be used as keys.
* @return An incomplete Join transformation.
@@ -87,7 +87,7 @@ public class JoinOperatorSetsBase
+ * Continues a Join transformation.
* Defines the fields of the first join {@link DataSet} that should be used as grouping keys. Fields
* are the names of member fields of the underlying type of the data set.
*
@@ -105,9 +105,9 @@ public class JoinOperatorSetsBase
* The KeySelector function is called for each element of the first DataSet and extracts a single
- * key value on which the DataSet is joined.
+ * key value on which the DataSet is joined.
*
* @param keySelector The KeySelector function which extracts the key values from the DataSet on which it is joined.
* @return An incomplete Join transformation.
@@ -125,7 +125,7 @@ public class JoinOperatorSetsBase
+ * Intermediate step of a Join transformation.
* To continue the Join transformation, select the join key of the second input {@link DataSet} by calling
* {@link org.apache.flink.api.java.operators.join.JoinOperatorSetsBase.JoinOperatorSetsPredicateBase#equalTo(int...)} or
* {@link org.apache.flink.api.java.operators.join.JoinOperatorSetsBase.JoinOperatorSetsPredicateBase#equalTo(KeySelector)}.
@@ -149,8 +149,8 @@ public class JoinOperatorSetsBase
- * Note: Fields can only be selected as join keys on Tuple DataSets.
+ * {@link DataSet} that should be used as join keys.
+ * Note: Fields can only be selected as join keys on Tuple DataSets.
*
* The resulting {@link JoinFunctionAssigner} needs to be finished by providing a
* {@link JoinFunction} by calling {@link JoinFunctionAssigner#with(JoinFunction)}
@@ -164,7 +164,7 @@ public class JoinOperatorSetsBase
+ * {@link DataSet} that should be used as join keys.
*
* The resulting {@link JoinFunctionAssigner} needs to be finished by providing a
* {@link JoinFunction} by calling {@link JoinFunctionAssigner#with(JoinFunction)}
@@ -177,9 +177,9 @@ public class JoinOperatorSetsBase
* The KeySelector function is called for each element of the second DataSet and extracts a single
- * key value on which the DataSet is joined.
+ * key value on which the DataSet is joined.
*
* The resulting {@link JoinFunctionAssigner} needs to be finished by providing a
* {@link JoinFunction} by calling {@link JoinFunctionAssigner#with(JoinFunction)}
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/operators/translation/Tuple3WrappingCollector.java b/flink-java/src/main/java/org/apache/flink/api/java/operators/translation/Tuple3WrappingCollector.java
index 66592f5e0479eb47d35d133b1cd860468daf71bf..29d68f188d21f3d536c3979ace09de5e8c476af6 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/operators/translation/Tuple3WrappingCollector.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/operators/translation/Tuple3WrappingCollector.java
@@ -22,7 +22,7 @@ import org.apache.flink.api.java.tuple.Tuple3;
import org.apache.flink.util.Collector;
/**
- * Needed to wrap tuples to Tuple3
+ * }
*
* Be aware that some annotations should only be used for functions with as single input
* ({@link MapFunction}, {@link ReduceFunction}) and some only for stubs with two inputs
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/record/io/ExternalProcessInputFormat.java b/flink-java/src/main/java/org/apache/flink/api/java/record/io/ExternalProcessInputFormat.java
index b1f7ffcc92ed21ccb8d97e0b04023847a7469fc0..cbf16b52d6030ced6e1f4ce6ed821711b3e08406 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/record/io/ExternalProcessInputFormat.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/record/io/ExternalProcessInputFormat.java
@@ -32,7 +32,7 @@ import org.apache.flink.core.io.GenericInputSplit;
* The input format checks the exit code of the process to validate whether the process terminated correctly. A list of allowed exit codes can be provided.
* The input format requires ({@link ExternalProcessInputSplit} objects that hold the command to execute.
*
- * Attention!
- * \@ConstantFieldsExcept(fields={2})
+ *
{@code
+ * {@literal @}ConstantFieldsExcept(fields={2})
* public class MyMapper extends MapFunction
* {
* public void map(Record record, Collector out)
@@ -56,7 +56,7 @@ import org.apache.flink.api.common.operators.util.UserCodeWrapper;
out.collect(record);
* }
* }
- *
+ * Attention!
* You must take care to read from (and process) both output streams of the process, standard out (stdout) and standard error (stderr).
* Otherwise, the input format might get deadlocked!
*
diff --git a/flink-java/src/main/java/org/apache/flink/api/java/typeutils/AvroTypeInfo.java b/flink-java/src/main/java/org/apache/flink/api/java/typeutils/AvroTypeInfo.java
index 59c7eb0f83f628729fa0ba75c52f8e2813df2fd5..5f74513e0819cfee00db28209bb76d1b7aaad436 100644
--- a/flink-java/src/main/java/org/apache/flink/api/java/typeutils/AvroTypeInfo.java
+++ b/flink-java/src/main/java/org/apache/flink/api/java/typeutils/AvroTypeInfo.java
@@ -29,8 +29,8 @@ import java.util.List;
/**
* Special type information to generate a special AvroTypeInfo for Avro POJOs (implementing SpecificRecordBase, the typed Avro POJOs)
*
- * Proceeding: It uses a regular pojo type analysis and replaces all GenericType
+ *
{@code
* SELECT
* c_custkey,
* c_name,
@@ -60,7 +60,7 @@ import org.apache.flink.api.java.tuple.Tuple6;
* c_acctbal,
* n_name,
* c_address
- * 1,2\n1,3\n defines two edges 1-2 and 1-3.
*
EuclideanGraphWeighing <vertex path> <edge path> <result path>
* Vertex centric algorithms operate on graphs, which are defined through vertices and edges. The
diff --git a/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java b/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java
index 248925b1be5dd6629d96f3cd8c161f663d74745f..857cef5da04511370399c34b7be7950d6fbcd4e1 100644
--- a/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java
+++ b/flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java
@@ -30,12 +30,12 @@ import org.apache.flink.util.Collector;
/**
* This class must be extended by functions that compute the state of the vertex depending on the old state and the
- * incoming messages. The central method is {@link #updateVertex(Comparable, Object, MessageIterator)}, which is
+ * incoming messages. The central method is {@link #updateVertex(Vertex, MessageIterator)}, which is
* invoked once per vertex per superstep.
*
- * >
+ *
* Nodes in the DAG correspond (almost) one-to-one to the operators in a program. The optimizer DAG is constructed
* to hold the additional information that the optimizer needs:
* It is possible to enter the {@code FAILED} state from any other state. Consider a job set up like this: The slot hierarchy in the slot sharing group will look like the following
* WARNING: If this method is invoked without any segment ever returning (for example, because the
- * {@link #readBlock(T)} method has not been invoked appropriately), the method may block
+ * {@link #readBlock} method has not been invoked appropriately), the method may block
* forever.
*
* @return The next memory segment from the reader's return queue.
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/disk/iomanager/BlockChannelWriter.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/disk/iomanager/BlockChannelWriter.java
index ccf065a9ac492210df4e7f28e6922faeddefe30c..d6cfd7e1041d6d6b1b5c1829f4a7e9b02b2bb727 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/io/disk/iomanager/BlockChannelWriter.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/io/disk/iomanager/BlockChannelWriter.java
@@ -35,7 +35,7 @@ public interface BlockChannelWriter
* NOTE: If this method is invoked without any segment ever returning (for example, because the
- * {@link #writeBlock(T)} method has not been invoked accordingly), the method may block
+ * {@link #writeBlock} method has not been invoked accordingly), the method may block
* forever.
*
* @return The next memory segment from the writers's return queue.
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/InputGate.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/InputGate.java
index f18c7e4d4a22b57a733e0f465ff94f56b953b243..d49b27ef72d291121022e9658ea752cbe34845d0 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/InputGate.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/InputGate.java
@@ -32,17 +32,17 @@ import java.io.IOException;
* As an example, consider a map-reduce program, where the map operator produces data and the
* reduce operator consumes the produced data.
*
- * When deploying such a program in parallel, the intermediate result will be partitioned over its
* producing parallel subtasks; each of these partitions is furthermore partitioned into one or more
* subpartitions.
*
- * In the above example, two map subtasks produce the intermediate result in parallel, resulting
* in two partitions (Partition 1 and 2). Each of these partitions is further partitioned into two
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/SingleInputGate.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/SingleInputGate.java
index 896fa9cb88d545f83bb040bb6a101b4e573b2425..47f9228832f9f779626a01652605ffb9c5a7922a 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/SingleInputGate.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/partition/consumer/SingleInputGate.java
@@ -66,17 +66,17 @@ import static com.google.common.base.Preconditions.checkState;
* As an example, consider a map-reduce program, where the map operator produces data and the
* reduce operator consumes the produced data.
*
- * When deploying such a program in parallel, the intermediate result will be partitioned over its
* producing parallel subtasks; each of these partitions is furthermore partitioned into one or more
* subpartitions.
*
- * In the above example, two map subtasks produce the intermediate result in parallel, resulting
* in two partitions (Partition 1 and 2). Each of these partitions is further partitioned into two
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/iterative/task/IterationIntermediateTask.java b/flink-runtime/src/main/java/org/apache/flink/runtime/iterative/task/IterationIntermediateTask.java
index 0d266c2190ceb8acb85880544e2ee022605483cd..68362371a919c0b70fc120b8fdc3089a0d8135db 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/iterative/task/IterationIntermediateTask.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/iterative/task/IterationIntermediateTask.java
@@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory;
import java.io.IOException;
/**
- * An intermediate iteration task, which runs a {@link org.apache.flink.runtime.operators.PactDriver} inside.
+ * An intermediate iteration task, which runs a {@link org.apache.flink.runtime.operators.Driver} inside.
*
* It will propagate {@link EndOfSuperstepEvent}s and {@link TerminationEvent}s to it's connected tasks. Furthermore
* intermediate tasks can also update the iteration state, either the workset or the solution set.
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/Scheduler.java b/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/Scheduler.java
index cb99e524d251f498b912822ee01100b3eae9b80b..963fc4c109b87fc8bb25fb54f3bc141c863760c0 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/Scheduler.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/Scheduler.java
@@ -57,7 +57,7 @@ import scala.concurrent.ExecutionContext;
* The scheduler supports two scheduling modes:
diff --git a/flink-optimizer/src/main/java/org/apache/flink/optimizer/operators/OperatorDescriptorSingle.java b/flink-optimizer/src/main/java/org/apache/flink/optimizer/operators/OperatorDescriptorSingle.java
index c8be5d4c183d4489a81562fd98e79c7191613aa1..ffa317caac5bddadfcafac6973329e81b609e22c 100644
--- a/flink-optimizer/src/main/java/org/apache/flink/optimizer/operators/OperatorDescriptorSingle.java
+++ b/flink-optimizer/src/main/java/org/apache/flink/optimizer/operators/OperatorDescriptorSingle.java
@@ -35,7 +35,7 @@ import org.apache.flink.optimizer.plan.SingleInputPlanNode;
* Abstract base class for Operator descriptions which instantiates the node and sets the driver
* strategy and the sorting and grouping keys. Returns possible local and global properties and
* updates them after the operation has been performed.
- * @see org.apache.flink.compiler.dag.SingleInputNode
+ * @see org.apache.flink.optimizer.dag.SingleInputNode
*/
public abstract class OperatorDescriptorSingle implements AbstractOperatorDescriptor {
diff --git a/flink-optimizer/src/main/java/org/apache/flink/optimizer/plan/Channel.java b/flink-optimizer/src/main/java/org/apache/flink/optimizer/plan/Channel.java
index b139b621e9d586f877d0676553479f101b53e02b..a4448c65ed3c1f65148d12ecfc584bd04e05445e 100644
--- a/flink-optimizer/src/main/java/org/apache/flink/optimizer/plan/Channel.java
+++ b/flink-optimizer/src/main/java/org/apache/flink/optimizer/plan/Channel.java
@@ -186,7 +186,6 @@ public class Channel implements EstimateProvider, Cloneable, DumpableConnection<
* Sets the data exchange mode (batch / pipelined) to use for the data
* exchange of this channel.
*
- * @return The data exchange mode of this channel.
*/
public void setDataExchangeMode(DataExchangeMode dataExchangeMode) {
this.dataExchangeMode = checkNotNull(dataExchangeMode);
diff --git a/flink-optimizer/src/main/java/org/apache/flink/optimizer/postpass/SparseKeySchema.java b/flink-optimizer/src/main/java/org/apache/flink/optimizer/postpass/SparseKeySchema.java
index e14888eaa7190c3c805a5b74bca92105ce5efd5e..1545d6f56aa9db69768172bc51f9d09b02a7a12f 100644
--- a/flink-optimizer/src/main/java/org/apache/flink/optimizer/postpass/SparseKeySchema.java
+++ b/flink-optimizer/src/main/java/org/apache/flink/optimizer/postpass/SparseKeySchema.java
@@ -26,7 +26,7 @@ import java.util.Map.Entry;
import org.apache.flink.types.Key;
/**
- * Class encapsulating a schema map (int column position -> column type) and a reference counter.
+ * Class encapsulating a schema map (int column position -> column type) and a reference counter.
*/
public class SparseKeySchema extends AbstractSchema
+ *
*
* {@code
*
* CREATED -> SCHEDULED -> DEPLOYING -> RUNNING -> FINISHED
* | | |
@@ -33,7 +33,7 @@ package org.apache.flink.runtime.execution;
* +-------------------------+
*
* ... -> FAILED
- *
+ * }
+ *
*
* {@code
* +-------------- Slot Sharing Group --------------+
* | |
* | +-- Co Location Group --+ |
@@ -66,7 +66,7 @@ import org.slf4j.LoggerFactory;
* | | | |
* | +-----------------------+ |
* +------------------------------------------------+
- *
+ * }
+ *
*
* {@code
* +-----+ +---------------------+ +--------+
* | Map | = produce => | Intermediate Result | <= consume = | Reduce |
* +-----+ +---------------------+ +--------+
- *
+ * }
+ *
*
* {@code
* Intermediate result
* +-----------------------------------------+
* | +----------------+ | +-----------------------+
@@ -57,7 +57,7 @@ import java.io.IOException;
* +-------+ | +-------------+ +=> | Subpartition 2 | | <==+======== | Input Gate | Reduce 2 |
* | +----------------+ | +-----------------------+
* +-----------------------------------------+
- *
+ * }
+ *
*
* {@code
* +-----+ +---------------------+ +--------+
* | Map | = produce => | Intermediate Result | <= consume = | Reduce |
* +-----+ +---------------------+ +--------+
- *
+ * }
+ *
*
* {@code
* Intermediate result
* +-----------------------------------------+
* | +----------------+ | +-----------------------+
@@ -91,7 +91,7 @@ import static com.google.common.base.Preconditions.checkState;
* +-------+ | +-------------+ +=> | Subpartition 2 | | <==+======== | Input Gate | Reduce 2 |
* | +----------------+ | +-----------------------+
* +-----------------------------------------+
- *
+ * }
*
JoinFunction#join() method for all two key-value pairs that share the same key and come
* from different inputs. The output of the join() method is forwarded.
- *
+ * * This method first zig-zags between the two sorted inputs in order to find a common * key, and then calls the join stub with the cross product of the values. * diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/operators/util/BloomFilter.java b/flink-runtime/src/main/java/org/apache/flink/runtime/operators/util/BloomFilter.java index 947a56bd0fd42c78a277eeab6439f04c70bab1b5..0ad3c6d6126614ff672493c3bffb41dd55f9ff50 100644 --- a/flink-runtime/src/main/java/org/apache/flink/runtime/operators/util/BloomFilter.java +++ b/flink-runtime/src/main/java/org/apache/flink/runtime/operators/util/BloomFilter.java @@ -6,9 +6,9 @@ * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at - *
+ ** http://www.apache.org/licenses/LICENSE-2.0 - *
+ ** Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -34,11 +34,11 @@ import static com.google.common.base.Preconditions.checkArgument; * During the creation of bloom filter expected number of entries must be specified. If the number * of insertions exceed the specified initial number of entries then false positive probability will * increase accordingly. - *
+ ** Internally, this implementation of bloom filter uses MemorySegment to store BitSet, BloomFilter and * BitSet are designed to be able to switch between different MemorySegments, so that Flink can share * the same BloomFilter/BitSet object instance for different bloom filters. - *
+ ** Part of this class refers to the implementation from Apache Hive project * https://github.com/apache/hive/blob/master/common/src/java/org/apache/hive/common/util/BloomFilter.java */ diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorUtils.java b/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorUtils.java index 181d6d6f72cbfca1639a5a577723a1615cfd61ae..a7a3458b298d2b91d7d83b8b8497848646596a69 100644 --- a/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorUtils.java +++ b/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorUtils.java @@ -113,7 +113,7 @@ public final class WebMonitorUtils { /** * Starts the web runtime monitor. Because the actual implementation of the runtime monitor is * in another project, we load the runtime monitor dynamically. - *
+ *
* Because failure to start the web runtime monitor is not considered fatal, this method does
* not throw any exceptions, but only logs them.
*
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/yarn/AbstractFlinkYarnCluster.java b/flink-runtime/src/main/java/org/apache/flink/runtime/yarn/AbstractFlinkYarnCluster.java
index 3f7889824e196cad47589b53046ee1b53ea805fd..d7ef9043c5fb6809bb4acb3a482dd547a2cae8d5 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/yarn/AbstractFlinkYarnCluster.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/yarn/AbstractFlinkYarnCluster.java
@@ -100,7 +100,9 @@ public abstract class AbstractFlinkYarnCluster {
/**
* Disconnect from the ApplicationMaster without stopping the session
- * (therefore, use the {@see shutdown()} method.
+ * (therefore, use the {@link AbstractFlinkYarnCluster#shutdown(boolean)} method.
+ *
+ * @see AbstractFlinkYarnCluster#shutdown(boolean)
*/
public abstract void disconnect();
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/zookeeper/StateStorageHelper.java b/flink-runtime/src/main/java/org/apache/flink/runtime/zookeeper/StateStorageHelper.java
index d18cace277e5fa36ea0c318afe9fdf61064ff843..36fb84987d922893af5082b8dfed15fc879c058b 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/zookeeper/StateStorageHelper.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/zookeeper/StateStorageHelper.java
@@ -23,7 +23,7 @@ import org.apache.flink.runtime.state.StateHandle;
import java.io.Serializable;
/**
- * State storage helper which is used by {@ZooKeeperStateHandleStore} to persiste state before
+ * State storage helper which is used by {@link ZooKeeperStateHandleStore} to persiste state before
* the state handle is written to ZooKeeper.
*
* @param ZooKeeper holds the ground truth about state handles, i.e. the following holds:
*
* Important: this does not discard the state handle. If you want to
* discard the state handle call {@link #removeAndDiscardState(String)}.
*
* @param pathInZooKeeper Path of state handle to remove (expected to start with a '/')
@@ -331,7 +331,7 @@ public class ZooKeeperStateHandleStore Important: this does not discard the state handle. If you want to
* discard the state handle call {@link #removeAndDiscardState(String)}.
*
* @param pathInZooKeeper Path of state handle to remove (expected to start with a '/')
diff --git a/flink-staging/flink-hadoop-compatibility/src/main/java/org/apache/flink/hadoopcompatibility/mapred/HadoopMapFunction.java b/flink-staging/flink-hadoop-compatibility/src/main/java/org/apache/flink/hadoopcompatibility/mapred/HadoopMapFunction.java
index 4d81dafb3e24a805e338fc8f222084b9a8f780d2..83ab23d8ef375e8e15edf6485e07407bbaaddb85 100644
--- a/flink-staging/flink-hadoop-compatibility/src/main/java/org/apache/flink/hadoopcompatibility/mapred/HadoopMapFunction.java
+++ b/flink-staging/flink-hadoop-compatibility/src/main/java/org/apache/flink/hadoopcompatibility/mapred/HadoopMapFunction.java
@@ -111,7 +111,7 @@ public final class HadoopMapFunction
* Example:
*
- *
* As seen above, a {@link org.apache.flink.api.table.Table} can be converted back to the
- * underlying API representation using {@link org.apache.flink.api.java.table.TableEnvironment.toSet}
- * or {@link org.apache.flink.api.java.table.TableEnvironment.toStream}.
+ * underlying API representation using {@link org.apache.flink.api.java.table.TableEnvironment#toDataSet(org.apache.flink.api.table.Table, java.lang.Class)}
+ * or {@link org.apache.flink.api.java.table.TableEnvironment#toDataStream(org.apache.flink.api.table.Table, java.lang.Class)}}.
*/
package org.apache.flink.api.java.table;
diff --git a/flink-streaming-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/FlinkKafkaConsumer.java b/flink-streaming-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/FlinkKafkaConsumer.java
index 8066b3cf0ad96955bb6c3b9b0306d92072226d57..c7ae1cc5ae1b5e61344b1d5f884c859cfbe9bfe4 100644
--- a/flink-streaming-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/FlinkKafkaConsumer.java
+++ b/flink-streaming-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/FlinkKafkaConsumer.java
@@ -79,7 +79,7 @@ import static com.google.common.base.Preconditions.checkNotNull;
*
- * State handle in ZooKeeper => State handle exists
+ * State handle in ZooKeeper => State handle exists
*
*
* But not:
*
*
- * State handle exists => State handle in ZooKeeper
+ * State handle exists => State handle in ZooKeeper
*
*
* There can be lingering state handles when failures happen during operation. They
@@ -316,7 +316,7 @@ public class ZooKeeperStateHandleStore
+ *
+ * }
*
* {@code
* ExecutionEnvironment env = ExecutionEnvironment.createCollectionsEnvironment();
*
* DataSet
*
* Flink Sinks: Kafka Partitions - * 1 ----------------> 1 + * 1 ----------------> 1 * 2 --------------/ * 3 -------------/ * 4 ------------/ *- * --> Some (or all) kafka partitions contain the output of more than one flink partition + * Some (or all) kafka partitions contain the output of more than one flink partition * *# Fewer Flink partitions than Kafka *
* Flink Sinks: Kafka Partitions - * 1 ----------------> 1 - * 2 ----------------> 2 - * 3 - * 4 - * 5 + * 1 ----------------> 1 + * 2 ----------------> 2 + * 3 + * 4 + * 5 ** - * --> Not all Kafka partitions contain data + * Not all Kafka partitions contain data * To avoid such an unbalanced partitioning, use a round-robin kafka partitioner. (note that this will * cause a lot of network connections between all the Flink instances and all the Kafka brokers * diff --git a/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/iteration/IterateExample.java b/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/iteration/IterateExample.java index 2cf66b99532e9ae45ffe152e598ad894931a9122..52ec896e8034ac508c2bb29e7bfe9fbaa4e5d21c 100644 --- a/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/iteration/IterateExample.java +++ b/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/iteration/IterateExample.java @@ -32,10 +32,11 @@ import java.util.List; import java.util.Random; /** - * Example illustrating iterations in Flink streaming.
The program sums up random numbers and counts additions + * Example illustrating iterations in Flink streaming. + *
The program sums up random numbers and counts additions * it performs to reach a specific threshold in an iterative streaming fashion.
- * - * + * + ** This example shows how to use:
* This example shows how to use: *
* By defaults emits the Integer 0 for every newData and the Integer 1 * for every model update. diff --git a/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/socket/SocketTextStreamWordCount.java b/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/socket/SocketTextStreamWordCount.java index 17add2c19c2c7ff84a4143cbd2e470dec2b34a0d..cecabddaf722dcbcee74efbcbd878f378847d7ee 100644 --- a/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/socket/SocketTextStreamWordCount.java +++ b/flink-streaming-examples/src/main/java/org/apache/flink/streaming/examples/socket/SocketTextStreamWordCount.java @@ -26,19 +26,16 @@ import org.apache.flink.streaming.examples.wordcount.WordCount.Tokenizer; * This example shows an implementation of WordCount with data from a text * socket. To run the example make sure that the service providing the text data * is already up and running. - *
- * + *
* To start an example socket text stream on your local machine run netcat from
* a command line: nc -lk 9999, where the parameter specifies the
* port number.
- *
* Usage:
* SocketTextStreamWordCount <hostname> <port> <result path>
- *
- *
* This example shows how to: *
* The input is a JSON text file with lines separated by newline characters. - *
- * + * + *
* Usage: TwitterStream <text path>
* If no parameters are provided, the program is run with default data from
* {@link TwitterStreamData}.
- *
* This example shows how to: *
* Implements a string tokenizer that splits sentences into words as a
* user-defined FlatMapFunction. The function takes a line (String) and
- * splits it into multiple pairs in the form of "(word,1)" (Tuple2
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/SingleOutputStreamOperator.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/SingleOutputStreamOperator.java
index 33d5a3c47884fd8592fa9eec95596d78ce240555..3722908597a0afd8ab29eaf5b88fb391bf9b5c75 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/SingleOutputStreamOperator.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/SingleOutputStreamOperator.java
@@ -133,7 +133,8 @@ public class SingleOutputStreamOperator Chaining can be turned off for the whole
* job by {@link StreamExecutionEnvironment#disableOperatorChaining()}
* however it is not advised for performance considerations.
*
@@ -279,7 +280,8 @@ public class SingleOutputStreamOperator Please note that
* local executions have by default as many available task slots as the
* environment parallelism, so in order to start a new resource group the
* degree of parallelism for the operators must be decreased from the
@@ -296,7 +298,8 @@ public class SingleOutputStreamOperator All subsequent operators are
* assigned to the default resource group.
*
* @return The operator with isolated resource group.
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java
index 98506e0dceb093747a1f7b6a77be77bb7d5bd4dc..210447d81a97c5b01352f42e333522cb7ac508a0 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java
@@ -183,7 +183,7 @@ public abstract class StreamExecutionEnvironment {
* output buffers. By default the output buffers flush frequently to provide
* low latency and to aid smooth developer experience. Setting the parameter
* can result in three logical modes:
- *
*
* Note that the serializer instance must be serializable (as defined by
* java.io.Serializable), because it may be distributed to the worker nodes
* by java serialization.
@@ -495,7 +495,7 @@ public abstract class StreamExecutionEnvironment {
/**
* Registers the given type with a Kryo Serializer.
- *
* Note that the serializer instance must be serializable (as defined by
* java.io.Serializable), because it may be distributed to the worker nodes
* by java serialization.
@@ -851,7 +851,7 @@ public abstract class StreamExecutionEnvironment {
* objects,
* rather than Java Strings. StringValues can be used to tune implementations to be less object and garbage
* collection heavy.
- *
* The file will be read with the system's default character set.
*
* @param filePath
@@ -873,7 +873,7 @@ public abstract class StreamExecutionEnvironment {
* objects, rather than Java Strings. StringValues can be used to tune implementations to be less object and
* garbage
* collection heavy.
- *
* The {@link java.nio.charset.Charset} with the given name will be used to read the files.
*
* @param filePath
@@ -992,7 +992,7 @@ public abstract class StreamExecutionEnvironment {
* Creates a new data stream that contains the strings received infinitely from a socket. Received strings are
* decoded by the system's default character set. On the termination of the socket server connection retries can be
* initiated.
- *
* Let us note that the socket itself does not report on abort and as a consequence retries are only initiated when
* the socket was gracefully terminated.
*
@@ -1050,7 +1050,7 @@ public abstract class StreamExecutionEnvironment {
/**
* Generic method to create an input data stream with {@link org.apache.flink.api.common.io.InputFormat}.
- *
* Since all data streams need specific information about their types, this method needs to determine the type of
* the data produced by the input format. It will attempt to determine the data type by reflection, unless the
* input
@@ -1194,7 +1194,7 @@ public abstract class StreamExecutionEnvironment {
* Triggers the program execution. The environment will execute all parts of
* the program that have resulted in a "sink" operation. Sink operations are
* for example printing results or forwarding them to a message queue.
- *
* The program execution will be logged and displayed with a generated
* default name.
*
@@ -1209,7 +1209,7 @@ public abstract class StreamExecutionEnvironment {
* Triggers the program execution. The environment will execute all parts of
* the program that have resulted in a "sink" operation. Sink operations are
* for example printing results or forwarding them to a message queue.
- *
* The program execution will be logged and displayed with the provided name
*
* @param jobName
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/source/RichSourceFunction.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/source/RichSourceFunction.java
index dd08b2ae14a8d49f62ee164dfcd23ecc23fba5f6..24f1a41ceeadaab30109b11002aa2d66f98157e4 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/source/RichSourceFunction.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/source/RichSourceFunction.java
@@ -36,7 +36,6 @@ import org.apache.flink.api.common.functions.AbstractRichFunction;
*
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/graph/StreamGraphGenerator.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/graph/StreamGraphGenerator.java
index 4a87eb3151aa4b848add1d5bc65ed7e47d364719..8bd0e482e9edd53d354f1af943eb5ee9e6683b91 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/graph/StreamGraphGenerator.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/graph/StreamGraphGenerator.java
@@ -61,7 +61,7 @@ import java.util.Map;
* in the graph with the desired property. For example, if you have this graph:
*
*
* The following graph of {@code StreamTransformations}:
*
- *
- * {@see #setBufferTimeout}
+ * @see #setBufferTimeout(long)
*/
public long getBufferTimeout() {
return bufferTimeout;
@@ -253,8 +252,7 @@ public abstract class StreamTransformation
- * {@see #setResourceStrategy}
+ * @see #setResourceStrategy(StreamGraph.ResourceStrategy)
*/
public StreamGraph.ResourceStrategy getResourceStrategy() {
return resourceStrategy;
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/windowing/time/Time.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/windowing/time/Time.java
index 7f9356a71d15b07d526b6213b0a4b517624d3edc..e0e92027eb8bd1d1490d8143b9950f607b906042 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/windowing/time/Time.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/windowing/time/Time.java
@@ -54,8 +54,7 @@ public final class Time extends AbstractTime {
* Creates a new {@link Time} of the given duration and {@link TimeUnit}.
*
* The {@code Time} refers to the time characteristic that is set on the dataflow via
- * {@link org.apache.flink.streaming.api.environment.StreamExecutionEnvironment#
- * setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic)}.
+ * {@link org.apache.flink.streaming.api.environment.StreamExecutionEnvironment#setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic)}.
*
* @param size The duration of time.
* @param unit The unit of time of the duration, for example {@code TimeUnit.SECONDS}.
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/runtime/tasks/StreamTask.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/runtime/tasks/StreamTask.java
index 8c58e29f3dd4f5727e39aafca5d704d79eff13c9..bae012866705dff6a61344a63586949457a66b8d 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/runtime/tasks/StreamTask.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/runtime/tasks/StreamTask.java
@@ -63,7 +63,7 @@ import org.slf4j.LoggerFactory;
* thus have multiple ends.
*
* The life cycle of the task is set up as follows:
- * The {@code StreamTask} has a lock object called {@code lock}. All calls to methods on a
* {@code StreamOperator} must be synchronized on this lock object to ensure that no methods
diff --git a/flink-streaming-java/src/test/java/org/apache/flink/streaming/runtime/tasks/OneInputStreamTaskTestHarness.java b/flink-streaming-java/src/test/java/org/apache/flink/streaming/runtime/tasks/OneInputStreamTaskTestHarness.java
index 7fb8ba35ddd6e17f0e53770876e8d9c832eb29e7..f6e297c32014a1b1310f3de9ae6e85f1122d7df7 100644
--- a/flink-streaming-java/src/test/java/org/apache/flink/streaming/runtime/tasks/OneInputStreamTaskTestHarness.java
+++ b/flink-streaming-java/src/test/java/org/apache/flink/streaming/runtime/tasks/OneInputStreamTaskTestHarness.java
@@ -49,7 +49,7 @@ import java.io.IOException;
*
*
* When using this you need to add the following line to your test class to setup Powermock:
- * {@code @PrepareForTest({ResultPartitionWriter.class})}
+ * {@code {@literal @}PrepareForTest({ResultPartitionWriter.class})}
*/
public class OneInputStreamTaskTestHarness
* When using this you need to add the following line to your test class to setup Powermock:
- * {@code @PrepareForTest({ResultPartitionWriter.class})}
+ * {@code {@literal @}PrepareForTest({ResultPartitionWriter.class})}
*/
public class StreamTaskTestHarness
* When using this you need to add the following line to your test class to setup Powermock:
- * {@code @PrepareForTest({ResultPartitionWriter.class})}
+ * {@code {@literal @}PrepareForTest({ResultPartitionWriter.class})}
*/
public class TwoInputStreamTaskTestHarness
*
- * {@code
* public class ExampleSource
+ * }
*
*
*
- * Map-1 -> HashPartition-2 -> Map-3
+ * Map-1 -> HashPartition-2 -> Map-3
*
*
* where the numbers represent transformation IDs. We first recurse all the way down. {@code Map-1}
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/StreamTransformation.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/StreamTransformation.java
index 4e6dc42288fd28be6b79dc6b28040b755d81cf9a..fd48fa788af2c2405d14ad758ec4714bd42d92cc 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/StreamTransformation.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/StreamTransformation.java
@@ -47,7 +47,7 @@ import java.util.Collection;
*
+ *
*
* Would result in this graph of operations at runtime:
*
- * {@code
* Source Source
* + +
* | |
@@ -72,11 +72,11 @@ import java.util.Collection;
* |
* v
* Sink
- *
+ * }
+ *
*
* The information about partitioning, union, split/select end up being encoded in the edges
* that connect the sources to the map operation.
@@ -233,8 +233,7 @@ public abstract class StreamTransformation{@code
* Source Source
* + +
* | |
@@ -86,7 +86,7 @@ import java.util.Collection;
* |
* v
* Sink
- *
+ * }
+ *
*
* {@code
* -- registerInputOutput()
* |
* +----> Create basic utils (config, etc) and load the chain of operators
@@ -80,7 +80,7 @@ import org.slf4j.LoggerFactory;
* +----> dispose-operators()
* +----> common cleanup
* +----> task specific cleanup()
- *
+ * }{@code
*
- * @Test
+ * {@literal @}Test
* public void someTest() {
* ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
* // test code
* env.execute();
* }
*
- * @Test
+ * {@literal @}Test
* public void anotherTest() {
* ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
* // test code
diff --git a/flink-tests/src/test/java/org/apache/flink/test/recordJobs/wordcount/WordCount.java b/flink-tests/src/test/java/org/apache/flink/test/recordJobs/wordcount/WordCount.java
index 96eb1fc539a077fef8152eb775b7c51066adb5aa..2fcc523424b55c4213ca022afca25b98d20b967e 100644
--- a/flink-tests/src/test/java/org/apache/flink/test/recordJobs/wordcount/WordCount.java
+++ b/flink-tests/src/test/java/org/apache/flink/test/recordJobs/wordcount/WordCount.java
@@ -45,6 +45,12 @@ import java.util.concurrent.TimeUnit;
/**
* Implements a word count which takes the input file and counts the number of
* the occurrences of each word in the file.
+ *
+ *
+ *
+ * Note: This example uses the out-dated Record API.
+ * It is recommended to use the new Java API.
+ *
*/
@SuppressWarnings("deprecation")
public class WordCount implements Program, ProgramDescription {