Skip to content

Commit 1627817

Browse files
committed
Javadoc
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1301938 13f79535-47bb-0310-9956-ffa450edef68
1 parent c9dedff commit 1627817

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,18 @@ public int read(char[] buf, int offset, int length) throws IOException {
100100
return len;
101101
}
102102

103+
/**
104+
* Calls {@link BufferedReader#readLine()} which drops the line terminator(s).
105+
* This method should only be called when processing a comment, otherwise
106+
* information can be lost.
107+
* <p>
108+
* Increments {@link #lineCounter}
109+
* <p>
110+
* Sets {@link #lastChar} to {@link #END_OF_STREAM} at EOF,
111+
* otherwise to last character on the line (won't be CR or LF)
112+
*
113+
* @return the line that was read, or null if reached EOF.
114+
*/
103115
@Override
104116
public String readLine() throws IOException {
105117
String line = super.readLine();

0 commit comments

Comments
 (0)