svn commit: r1522861 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java

[britter]

Author: britter
Date: Fri Sep 13 10:53:33 2013
New Revision: 1522861

URL: http://svn.apache.org/r1522861
Log:
Add documentation about parsing CSV content into memory

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=1522861&r1=1522860&r2=1522861&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 10:53:33 2013
@@ -92,7 +92,7 @@ import java.util.NoSuchElementException;
  *
  * <h4>Parsing completely into memory</h4>
  * <p>
- * You may also get a List of records:
+ * If parsing record wise is not desired, the contents of the input can be 
read completely into memory.
  * </p>
  *
  * <pre>
@@ -100,6 +100,20 @@ import java.util.NoSuchElementException;
  * CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
  * List&lt;CSVRecord&gt; list = parser.getRecords();
  * </pre>
+ *
+ * <p>
+ * There are two constraints that have to be kept in mind:
+ * </p>
+ *
+ * <p>
+ * <ol>
+ *     <li>Parsing into memory starts at the current position of the parser. 
If you have already parsed records from
+ *     the input, those records will not end up in the in memory 
representation of your CSV data.</li>
+ *     <li>Parsing into memory may consume a lot of system resources depending 
on the input. For example if you're
+ *     parsing a 150MB file of CSV data the contents will be read completely 
into memory.</li>
+ * </ol>
+ * </p>
+ *
  * <p>
  * Internal parser state is completely covered by the format and the 
reader-state.
  * </p>