Author: britter
Date: Fri Sep 13 09:07:41 2013
New Revision: 1522823
URL: http://svn.apache.org/r1522823
Log:
Document how to create CSVParser instances
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java?rev=1522823&r1=1522822&r2=1522823&view=diff
==============================================================================
---
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
(original)
+++
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
Fri Sep 13 09:07:41 2013
@@ -41,6 +41,18 @@ import java.util.NoSuchElementException;
* Because CSV appears in many different dialects, the parser supports many
formats by allowing the
* specification of a {@link CSVFormat}.
*
+ * There are several static factory methods that can be used to create
instances for various types of resources:
+ * <p>
+ * <ul>
+ * <li>{@link #parse(java.io.File, CSVFormat)}</li>
+ * <li>{@link #parse(String, CSVFormat)}</li>
+ * <li>{@link #parse(java.net.URL, java.nio.charset.Charset,
CSVFormat)}</li>
+ * </ul>
+ * </p>
+ * <p>
+ * Alternatively parsers can also be created by passing a {@link Reader}
directly to the sole constructor.
+ * </p>
+ *
* <p>
* To parse a CSV input with tabs as separators, '"' (double-quote) as an
optional value encapsulator, and comments
* starting with '#', you write:
