[
https://issues.apache.org/jira/browse/FLINK-10924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16700650#comment-16700650
]
ASF GitHub Bot commented on FLINK-10924:
----------------------------------------
zentol closed pull request #7143: [FLINK-10924] [javadoc]
StreamExecutionEnvironment method javadocs in…
URL: https://github.com/apache/flink/pull/7143
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git
a/flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java
b/flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java
index 2bed411840d..22a2a93f066 100644
---
a/flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java
+++
b/flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java
@@ -384,7 +384,7 @@ public void registerType(Class<?> type) {
/**
* Creates a {@link DataSet} that represents the Strings produced by
reading the given file line wise.
- * The file will be read with the system's default character set.
+ * The file will be read with the UTF-8 character set.
*
* @param filePath The path of the file, as a URI (e.g.,
"file:///some/local/file" or "hdfs://host:port/file/path").
* @return A {@link DataSet} that represents the data read from the
given file as text lines.
@@ -419,7 +419,7 @@ public void registerType(Class<?> type) {
* {@link StringValue} objects, rather than Java Strings. StringValues
can be used to tune implementations
* to be less object and garbage collection heavy.
*
- * <p>The file will be read with the system's default character set.
+ * <p>The file will be read with the UTF-8 character set.
*
* @param filePath The path of the file, as a URI (e.g.,
"file:///some/local/file" or "hdfs://host:port/file/path").
* @return A {@link DataSet} that represents the data read from the
given file as text lines.
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 ed69ed4ab84..6acd6f01e99 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
@@ -923,7 +923,7 @@ public TimeCharacteristic getStreamTimeCharacteristic() {
/**
* Reads the given file line-by-line and creates a data stream that
contains a string with the
- * contents of each such line. The file will be read with the system's
default character set.
+ * contents of each such line. The file will be read with the UTF-8
character set.
*
* <p><b>NOTES ON CHECKPOINTING: </b> The source monitors the path,
creates the
* {@link org.apache.flink.core.fs.FileInputSplit FileInputSplits} to
be processed, forwards
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> StreamExecutionEnvironment method javadocs incorrect in regards to used
> charset
> -------------------------------------------------------------------------------
>
> Key: FLINK-10924
> URL: https://issues.apache.org/jira/browse/FLINK-10924
> Project: Flink
> Issue Type: Bug
> Components: Documentation, Streaming
> Affects Versions: 1.3.3, 1.4.2, 1.5.5, 1.6.2, 1.7.0
> Reporter: Chesnay Schepler
> Assignee: TisonKun
> Priority: Major
> Labels: pull-request-available
>
> Various methods of the {{StreamExecutionEnvironment}} (like
> [readTextFile|https://github.com/apache/flink/blob/master/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java#L939])
> are documented to be using the system's default charset if none is specified.
> This is incorrect as they default to UTF-8 instead. The javadocs should be
> updated to reflect this.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
