|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
Class LineNumberReader
java.io.LineNumberReader
All Implemented Interfaces:
public class LineNumberReader
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.
Since:
1.1
Author:
Mark Reinhold
Fields inherited from class java.io. Reader |
|
Constructor Summary |
|
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.
|
Method Summary |
int |
Get the current line number.
|
void |
Mark the present position in the stream.
|
int |
Read a single character.
|
int |
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
|
Read a line of text.
|
void |
Reset the stream to the most recent mark.
|
void |
Set the current line number.
|
long |
Skips characters.
|
Methods inherited from class java.io. Reader |
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Create a new line-numbering reader, using the default input-buffer
size.
Parameters:
in - A Reader object to provide the underlying stream
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
sz - An int specifying the size of the buffer
public void setLineNumber |
(int lineNumber) |
Set the current line number.
Parameters:
lineNumber - An int specifying the line number
See Also:
public int getLineNumber |
() |
Get the current line number.
Returns:
The current line number
See Also:
public int read |
() |
throws |
|
Read a single character.
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.
Overrides:
Returns:
The character read, or -1 if the end of the stream has been
reached
Throws:
public int read |
(char[] cbuf,
int off,
int len) |
throws |
|
Reads 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.
Overrides:
Parameters:
cbuf - Destination buffer
off - Offset at which to start storing characters
len - Maximum number of characters to read
Returns:
The number of characters read, or -1 if the end of the
stream has been reached
Throws:
Read a line of text.
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.
Overrides:
Returns:
A String containing the contents of the line, not including
any
line termination characters, or
null if the end of the stream has been reached
public long skip |
(long n) |
throws |
|
Skips characters. This method will block until some characters are
available, an I/O error occurs, or the end of the stream is reached.
If the stream is already at its end before this method is invoked,
then no characters are skipped and zero is returned.
Overrides:
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
public void mark |
(int readAheadLimit) |
throws |
|
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.
Overrides:
Parameters:
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.
Throws:
public void reset |
() |
throws |
|
Reset the stream to the most recent mark.
Overrides:
Throws:
IOException - If the stream has not been marked, or if the mark has been
invalidated
|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz