commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From yo...@apache.org
Subject svn commit: r483683 - /jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java
Date Thu, 07 Dec 2006 21:50:06 GMT
Author: yonik
Date: Thu Dec  7 13:50:05 2006
New Revision: 483683

URL: http://svn.apache.org/viewvc?view=rev&rev=483683
Log:
CSVParser javadoc cleanup (and remove ref to M$ [sic])

Modified:
    jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java

Modified: jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java
URL: http://svn.apache.org/viewvc/jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java?view=diff&rev=483683&r1=483682&r2=483683
==============================================================================
--- jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java (original)
+++ jakarta/commons/sandbox/csv/trunk/src/java/org/apache/commons/csv/CSVParser.java Thu Dec
 7 13:50:05 2006
@@ -16,31 +16,27 @@
  */
 package org.apache.commons.csv;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.Reader;
+import java.io.*;
 import java.util.ArrayList;
 
 
 /**
- * Parses cvs files according to the specified configuration.
+ * Parses CSV files according to the specified configuration.
  *
- * Because CSV appears in many different dialects the parser supports many
- * configuration settings. One of the most popular CSV format as supported
- * by the M$ corporation (excel-spreadsheets) are supported out-of-the-box
- * by the corresponding strategy setter (see {@link #setExcelStrategy()}).
+ * Because CSV appears in many different dialects, the parser supports many
+ * configuration settings by allowing the specification of a {@link CSVStrategy}.
  * 
- * <p>Parsing of a csv-string having ';' as separator:</p>
+ * <p>Parsing of a csv-string having tabs as separators,
+ * '"' as an optional value encapsulator, and comments starting with '#':</p>
  * <pre>
  *  String[][] data = 
- *      (new CSVParser(new StringReader("a;b\nc;d"),';')).getAllValues();
+ *   (new CSVParser(new StringReader("a\tb\nc\td"), new CSVStrategy('\t','"','#'))).getAllValues();
  * </pre>
  * 
- * <p>The API allows chained method calls, if you like this coding style:</p>
+ * <p>Parsing of a csv-string in Excel CSV format</p>
  * <pre>
- *  String[][] data = (new CSVParser(new StringReader("a;b\nc;d"),';'))
- *      .setExcelStrategy().setIgnoreEmptyLines(true).getAllValues();
+ *  String[][] data =
+ *   (new CSVParser(new StringReader("a;b\nc;d"), CSVStrategy.EXCEL_STRATEGY)).getAllValues();
  * </pre>
  * 
  * <p>



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message