Author: sebb
Date: Sat Mar 17 13:37:54 2012
New Revision: 1301938
URL: http://svn.apache.org/viewvc?rev=1301938&view=rev
Log:
Javadoc
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java
URL:
http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java?rev=1301938&r1=1301937&r2=1301938&view=diff
==============================================================================
---
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java
(original)
+++
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java
Sat Mar 17 13:37:54 2012
@@ -100,6 +100,18 @@ class ExtendedBufferedReader extends Buf
return len;
}
+ /**
+ * Calls {@link BufferedReader#readLine()} which drops the line
terminator(s).
+ * This method should only be called when processing a comment, otherwise
+ * information can be lost.
+ * <p>
+ * Increments {@link #lineCounter}
+ * <p>
+ * Sets {@link #lastChar} to {@link #END_OF_STREAM} at EOF,
+ * otherwise to last character on the line (won't be CR or LF)
+ *
+ * @return the line that was read, or null if reached EOF.
+ */
@Override
public String readLine() throws IOException {
String line = super.readLine();
