Document reliance of parse(File, CSVFormat) to default encoding

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1592604 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2014-05-05 18:45:55 +00:00
parent 129a8db75e
commit c08219e0d7
1 changed files with 5 additions and 0 deletions

View File

@ -135,6 +135,11 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
/**
* Creates a parser for the given {@link File}.
*
* <p><strong>Note:</strong> This method internally creates a FileReader using
* {@link 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>
*
* @param file
* a CSV file. Must not be null.
* @param format