| |
|
| java.lang.Object
 java.io.InputStream
java.io.FilterInputStream
java.io.LineNumberInputStream
| LineNumberInputStream | | public class LineNumberInputStream extends FilterInputStream (Code) | | This class is an input stream filter that provides the added
functionality of keeping track of the current line number.
A line is a sequence of bytes ending with a carriage return
character ('\r'), a newline character
('\n'), or a carriage return character followed
immediately by a linefeed character. In all three cases, the line
terminating character(s) are returned as a single newline character.
The line number begins at 0, and is incremented by
1 when a read returns a newline character.
author:
Arthur van Hoff
version:
1.34, 05/05/07
See Also: java.io.LineNumberReader
since:
JDK1.0 |
| Method Summary | |
| public int | available()
Returns the number of bytes that can be read from this input
stream without blocking. | | public int | getLineNumber()
Returns the current line number. | | public void | mark(int readlimit)
Marks the current position in this input stream. | | public int | read()
Reads the next byte of data from this input stream. | | public int | read(byte b, int off, int len)
Reads up to len bytes of data from this input stream
into an array of bytes. | | public void | reset()
Repositions this stream to the position at the time the
mark method was last called on this input stream. | | public void | setLineNumber(int lineNumber)
Sets the line number to the specified argument. | | public long | skip(long n)
Skips over and discards n bytes of data from this
input stream. |
| lineNumber | | int lineNumber(Code) | | |
| markLineNumber | | int markLineNumber(Code) | | |
| markPushBack | | int markPushBack(Code) | | |
| LineNumberInputStream | | public LineNumberInputStream(InputStream in)(Code) | | Constructs a newline number input stream that reads its input
from the specified input stream.
Parameters:
in - the underlying input stream. |
| available | | public int available() throws IOException(Code) | | Returns the number of bytes that can be read from this input
stream without blocking.
Note that if the underlying input stream is able to supply
k input characters without blocking, the
LineNumberInputStream can guarantee only to provide
k/2 characters without blocking, because the
k characters from the underlying input stream might
consist of k/2 pairs of '\r' and
'\n', which are converted to just
k/2 '\n' characters.
the number of bytes that can be read from this input streamwithout blocking.
exception:
IOException - if an I/O error occurs.
See Also: java.io.FilterInputStream.in |
| mark | | public void mark(int readlimit)(Code) | | Marks the current position in this input stream. A subsequent
call to the reset method repositions this stream at
the last marked position so that subsequent reads re-read the same bytes.
The mark method of
LineNumberInputStream remembers the current line
number in a private variable, and then calls the mark
method of the underlying input stream.
Parameters:
readlimit - the maximum limit of bytes that can be read beforethe mark position becomes invalid.
See Also: java.io.FilterInputStream.in
See Also: java.io.LineNumberInputStream.reset |
| read | | public int read() throws IOException(Code) | | Reads the next byte of data from this input stream. The value
byte is returned as an int in the range
0 to 255. If no byte is available
because the end of the stream has been reached, the value
-1 is returned. This method blocks until input data
is available, the end of the stream is detected, or an exception
is thrown.
The read method of
LineNumberInputStream calls the read
method of the underlying input stream. It checks for carriage
returns and newline characters in the input, and modifies the
current line number as appropriate. A carriage-return character or
a carriage return followed by a newline character are both
converted into a single newline character.
the next byte of data, or -1 if the end of thisstream is reached.
exception:
IOException - if an I/O error occurs.
See Also: java.io.FilterInputStream.in
See Also: java.io.LineNumberInputStream.getLineNumber |
| read | | public int read(byte b, int off, int len) throws IOException(Code) | | Reads up to len bytes of data from this input stream
into an array of bytes. This method blocks until some input is available.
The read method of
LineNumberInputStream repeatedly calls the
read method of zero arguments to fill in the byte array.
Parameters:
b - the buffer into which the data is read.
Parameters:
off - the start offset of the data.
Parameters:
len - the maximum number of bytes read. the total number of bytes read into the buffer, or-1 if there is no more data because the end ofthis stream has been reached.
exception:
IOException - if an I/O error occurs.
See Also: java.io.LineNumberInputStream.read |
| reset | | public void reset() throws IOException(Code) | | Repositions this stream to the position at the time the
mark method was last called on this input stream.
The reset method of
LineNumberInputStream resets the line number to be
the line number at the time the mark method was
called, and then calls the reset method of the
underlying input stream.
Stream marks are intended to be used in
situations where you need to read ahead a little to see what's in
the stream. Often this is most easily done by invoking some
general parser. If the stream is of the type handled by the
parser, it just chugs along happily. If the stream is not of
that type, the parser should toss an exception when it fails,
which, if it happens within readlimit bytes, allows the outer
code to reset the stream and try another parser.
exception:
IOException - if an I/O error occurs.
See Also: java.io.FilterInputStream.in
See Also: java.io.LineNumberInputStream.mark(int) |
| skip | | public long skip(long n) throws IOException(Code) | | Skips over and discards n bytes of data from this
input stream. The skip method may, for a variety of
reasons, end up skipping over some smaller number of bytes,
possibly 0. The actual number of bytes skipped is
returned. If n is negative, no bytes are skipped.
The skip method of LineNumberInputStream creates
a byte array and then repeatedly reads into it until
n bytes have been read or the end of the stream has
been reached.
Parameters:
n - the number of bytes to be skipped. the actual number of bytes skipped.
exception:
IOException - if an I/O error occurs.
See Also: java.io.FilterInputStream.in |
|
|
|