org.apache.commons.csv

Class ExtendedBufferedReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

org.apache.commons.csv.ExtendedBufferedReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

final class ExtendedBufferedReader
extends java.io.BufferedReader

A special buffered reader which supports sophisticated read access.

In particular the reader supports a look-ahead option, which allows you to see the next char returned by read(). This reader also tracks how many characters have been read with getPosition().

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closed
private long	eolCounter The count of EOLs (CR/LF/CRLF) seen so far
private int	lastChar The last char returned
private long	position The position, which is number of characters read so far

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
ExtendedBufferedReader(java.io.Reader reader) Created extended buffered reader using default buffer-size

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream.
(package private) long	getCurrentLineNumber() Returns the current line number
(package private) int	getLastChar() Returns the last character that was read as an integer (0 to 65535).
(package private) long	getPosition() Gets the character position in the reader.
boolean	isClosed()
(package private) int	lookAhead() Returns the next character in the current reader without consuming it.
int	read()
int	read(char[] buf, int offset, int length)
java.lang.String	readLine() Calls BufferedReader.readLine() which drops the line terminator(s).

Methods inherited from class java.io.BufferedReader

lines, mark, markSupported, ready, reset, skip

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lastChar

private int lastChar

The last char returned

eolCounter

private long eolCounter

The count of EOLs (CR/LF/CRLF) seen so far

position

private long position

The position, which is number of characters read so far

closed

private boolean closed

Constructor Detail

ExtendedBufferedReader

ExtendedBufferedReader(java.io.Reader reader)

Created extended buffered reader using default buffer-size

Method Detail

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.BufferedReader

Throws:

java.io.IOException

getLastChar

int getLastChar()

Returns the last character that was read as an integer (0 to 65535). This will be the last character returned by any of the read methods. This will not include a character read using the lookAhead() method. If no character has been read then this will return Constants.UNDEFINED. If the end of the stream was reached on the last read then this will return Constants.END_OF_STREAM.

Returns:

the last character that was read

read

public int read(char[] buf,
                int offset,
                int length)
         throws java.io.IOException

Overrides:

read in class java.io.BufferedReader

Throws:

java.io.IOException

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Calls BufferedReader.readLine() which drops the line terminator(s). This method should only be called when processing a comment, otherwise information can be lost.

Increments eolCounter

Sets lastChar to Constants.END_OF_STREAM at EOF, otherwise to LF

Overrides:

readLine in class java.io.BufferedReader

Returns:

the line that was read, or null if reached EOF.

Throws:

java.io.IOException

lookAhead

int lookAhead()
       throws java.io.IOException

Returns the next character in the current reader without consuming it. So the next call to read() will still return this value. Does not affect line number or last character.

Returns:

the next character

Throws:

java.io.IOException - if there is an error in reading

getCurrentLineNumber

long getCurrentLineNumber()

Returns the current line number

Returns:

the current line number

getPosition

long getPosition()

Gets the character position in the reader.

Returns:

the current position in the reader (counting characters, not bytes since this is a Reader)

isClosed

public boolean isClosed()

close

public void close()
           throws java.io.IOException

Closes the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.BufferedReader

Throws:

java.io.IOException - If an I/O error occurs