[
https://issues.apache.org/jira/browse/CSV-133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14130805#comment-14130805
]
Holger Stratmann commented on CSV-133:
--------------------------------------
Yep, I guess whoever knows what to pass as charset would know what it does...
in other news, though: The doc for the parameter "charset" says "A charset".
Not sure how helpful that is? For "file", it specifies that it must not be null
(which is really obvious??) - what about the charset? I guess it cannot be null
either (which is less obvious, it could default to system default). Maybe wanna
add a short note there and then we wouldn't need a note above.
> incorrect / obsolete JavaDoc for CSVParser
> ------------------------------------------
>
> Key: CSV-133
> URL: https://issues.apache.org/jira/browse/CSV-133
> Project: Commons CSV
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.0, 1.1
> Reporter: Holger Stratmann
> Priority: Trivial
> Labels: documentation
> Original Estimate: 10m
> Remaining Estimate: 10m
>
> In CSV-131, you asked for more reports, so here we go :)
> The JavaDoc for {{public static CSVParser parse(final File file, final
> Charset charset, final CSVFormat format)}} seems to be obsolete. It says
> {quote}
> <p><strong>Note:</strong> This method internally creates a FileReader using
> \{@link java.io.FileReader#FileReader(java.io.File)\} which in turn relies on
> the default encoding of the JVM that is executing the code. If this is
> insufficient create a URL to the file and use \{@link #parse(URL, Charset,
> CSVFormat)\}</p>
> {quote}
> ... which is clearly no longer the case since the method now takes a charset
> as a parameter and creates a "FileInputStreamReader" with this charset.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)