Closeable
, AutoCloseable
, Readable
A buffered character-input stream that keeps track of line numbers. This class defines methods
setLineNumber(int)
and
getLineNumber()
for setting and getting the current line number respectively.
By default, line numbering begins at 0. This number increments at every line terminator as the data is read, and at the end of the stream if the last character in the stream is not a line terminator. This number 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, or any of the previous terminators followed by end of stream, or end of stream not preceded by another terminator.
Constructors
Create a new line-numbering reader, using the default input-buffer size.
Create a new line-numbering reader, reading characters into a buffer of the given size.
int
Get the current line number.
void
Mark the present position in the stream.
int
int
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
void
Reset the stream to the most recent mark.
void
Set the current line number.
Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Create a new line-numbering reader, using the default input-buffer size.
in
- A Reader object to provide the underlying stream
Create a new line-numbering reader, reading characters into a buffer of the given size.
in
- A Reader object to provide the underlying stream
sz
- An int specifying the size of the buffer
public void setLineNumber(int lineNumber)
Set the current line number.
lineNumber
- An int specifying the line number
public int getLineNumber()
Get the current line number.
Read a single character.
Line terminatorsare compressed into single newline ('\n') characters. The current line number is incremented whenever a line terminator is read, or when the end of the stream is reached and the last character in the stream is not a line terminator.
read
in class BufferedReader
IOException
- If an I/O error occurs
throws
IOExceptionReads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.
If len
is zero, then no characters are read and 0
is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1
is returned; otherwise, at least one character is read and stored into cbuf
.
Line terminators are compressed into single newline ('\n') characters. The current line number is incremented whenever a line terminator is read, or when the end of the stream is reached and the last character in the stream is not a line terminator.
read
in class BufferedReader
cbuf
- Destination buffer
off
- Offset at which to start storing characters
len
- Maximum number of characters to read
IndexOutOfBoundsException
- If off
is negative, or len
is negative, or len
is greater than cbuf.length - off
IOException
- If an I/O error occurs
Read a line of text.
Line terminatorsare compressed into single newline ('\n') characters. The current line number is incremented whenever a line terminator is read, or when the end of the stream is reached and the last character in the stream is not a line terminator.
readLine
in class BufferedReader
null
if the end of the stream has been reached
IOException
- If an I/O error occurs
throws
IOExceptionMark 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.
mark
in class BufferedReader
readAheadLimit
- Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.
IOException
- If an I/O error occurs
Reset the stream to the most recent mark.
reset
in class BufferedReader
IOException
- If the stream has not been marked, or if the mark has been invalidated
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4