| java.lang.Object
 java.io.Reader
java.io.BufferedReader
java.io.LineNumberReader
| LineNumberReader | | public class LineNumberReader extends BufferedReader (Code) | | A buffered character-input stream that keeps track of line numbers.
This class defines methods void setLineNumber(int) and
int getLineNumber() for setting and getting the current
line number respectively.
By default, line numbering begins at 0. This number increments as data is
read, and can be changed with a call to setLineNumber(int).
Note however, that setLineNumber(int) does not actually change the current
position in the stream; it only changes the value that will be returned
by getLineNumber().
A line is considered to be terminated by any one of a line feed ('\n'), a carriage
return ('\r'), or a carriage return followed immediately by a linefeed.
version:
1.13, 00/02/02
author:
Mark Reinhold
since:
JDK1.1 |
| Constructor Summary | |
| public | LineNumberReader(Reader in)
Create a new line-numbering reader, using the default input-buffer
size. | | public | LineNumberReader(Reader in, int sz)
Create a new line-numbering reader, reading characters into a buffer of
the given size. |
| Method Summary | |
| public int | getLineNumber()
Get the current line number. | | public void | mark(int readAheadLimit)
Mark the present position in the stream. | | public int | read()
Read a single character. | | public int | read(char cbuf, int off, int len)
Read characters into a portion of an array. | | public String | readLine()
Read a line of text. | | public void | reset()
Reset the stream to the most recent mark. | | public void | setLineNumber(int lineNumber)
Set the current line number. | | public long | skip(long n)
Skip characters. |
| LineNumberReader | | public LineNumberReader(Reader in)(Code) | | Create a new line-numbering reader, using the default input-buffer
size.
Parameters:
in - a Reader object to provide the underlying stream. |
| LineNumberReader | | public LineNumberReader(Reader in, int sz)(Code) | | Create a new line-numbering reader, reading characters into a buffer of
the given size.
Parameters:
in - a Reader object to provide the underlying stream.
Parameters:
sz - an int specifying the size of the buffer. |
| mark | | public void mark(int readAheadLimit) throws IOException(Code) | | Mark the present position in the stream. Subsequent calls to reset()
will attempt to reposition the stream to this point, and will also reset
the line number appropriately.
Parameters:
readAheadLimit - Limit on the number of characters that may beread while still preserving the mark. Afterreading this many characters, attempting toreset the stream may fail.
exception:
IOException - If an I/O error occurs |
| read | | public int read() throws IOException(Code) | | Read a single character. Line terminators are compressed into single
newline ('\n') characters.
The character read, or -1 if the end of the stream has beenreached
exception:
IOException - If an I/O error occurs |
| read | | public int read(char cbuf, int off, int len) throws IOException(Code) | | Read characters into a portion of an array.
Parameters:
cbuf - Destination buffer
Parameters:
off - Offset at which to start storing characters
Parameters:
len - Maximum number of characters to read The number of bytes read, or -1 if the end of the stream hasalready been reached
exception:
IOException - If an I/O error occurs |
| readLine | | public String readLine() throws IOException(Code) | | Read a line of text. A line is considered to be terminated by any one
of a line feed ('\n'), a carriage return ('\r'), or a carriage return
followed immediately by a linefeed.
A String containing the contents of the line, not includingany line-termination characters, or null if the end of thestream has been reached
exception:
IOException - If an I/O error occurs |
| reset | | public void reset() throws IOException(Code) | | Reset the stream to the most recent mark.
exception:
IOException - If the stream has not been marked,or if the mark has been invalidated |
| setLineNumber | | public void setLineNumber(int lineNumber)(Code) | | Set the current line number.
Parameters:
lineNumber - an int specifying the line number.
See Also: LineNumberReader.getLineNumber |
| skip | | public long skip(long n) throws IOException(Code) | | Skip characters.
Parameters:
n - The number of characters to skip The number of characters actually skipped
exception:
IOException - If an I/O error occurs |
|
|