Skip to content

Commit e9ff3ef

Browse files
committed
Document how to create CSVParser instances
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1522823 13f79535-47bb-0310-9956-ffa450edef68
1 parent ad956f3 commit e9ff3ef

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/main/java/org/apache/commons/csv/CSVParser.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,18 @@
4141
* Because CSV appears in many different dialects, the parser supports many formats by allowing the
4242
* specification of a {@link CSVFormat}.
4343
*
44+
* There are several static factory methods that can be used to create instances for various types of resources:
45+
* <p>
46+
* <ul>
47+
* <li>{@link #parse(java.io.File, CSVFormat)}</li>
48+
* <li>{@link #parse(String, CSVFormat)}</li>
49+
* <li>{@link #parse(java.net.URL, java.nio.charset.Charset, CSVFormat)}</li>
50+
* </ul>
51+
* </p>
52+
* <p>
53+
* Alternatively parsers can also be created by passing a {@link Reader} directly to the sole constructor.
54+
* </p>
55+
*
4456
* <p>
4557
* To parse a CSV input with tabs as separators, '"' (double-quote) as an optional value encapsulator, and comments
4658
* starting with '#', you write:

0 commit comments

Comments
 (0)