@Deprecated public class LineNumberInputStream extends FilterInputStream
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.
LineNumberReader
in| Constructor and Description |
|---|
LineNumberInputStream(InputStream
Deprecated.
Constructs a newline number input stream that reads its input from the specified input stream.
|
| Modifier and Type | Method and Description |
|---|---|
int |
available()
Deprecated.
Returns the number of bytes that can be read from this input stream without blocking.
|
int |
getLineNumber()
Deprecated.
Returns the current line number.
|
void |
mark(int readlimit)
Deprecated.
Marks the current position in this input stream.
|
int |
read()
Deprecated.
Reads the next byte of data from this input stream.
|
int |
read(byte[] b, int off, int len)
Deprecated.
Reads up to
len bytes of data from this input stream into an array of bytes.
|
void |
reset()
Deprecated.
Repositions this stream to the position at the time the
mark method was last called on this input stream.
|
void |
setLineNumber(int lineNumber)
Deprecated.
Sets the line number to the specified argument.
|
long |
skip(long n)
Deprecated.
Skips over and discards
n bytes of data from this input stream.
|
close, markSupported, readpublic LineNumberInputStream(InputStreamin)
in - the underlying input stream.
public int read()
throws IOException
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.
read in class
FilterInputStream
-1 if the end of this stream is reached.
IOException - if an I/O error occurs.
FilterInputStream.in ,
getLineNumber()
public int read(byte[] b,
int off,
int len)
throws IOException
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.
read in class
FilterInputStream
b - the buffer into which the data is read.
off - the start offset of the data.
len - the maximum number of bytes read.
-1 if there is no more data because the end of this stream has been reached.
IOException - if an I/O error occurs.
read()
public long skip(long n)
throws IOException
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.
skip in class
FilterInputStream
n - the number of bytes to be skipped.
IOException - if an I/O error occurs.
FilterInputStream.in
public void setLineNumber(int lineNumber)
lineNumber - the new line number.
getLineNumber()
public int getLineNumber()
setLineNumber(int)
public int available()
throws IOException
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.
available in class
FilterInputStream
IOException - if an I/O error occurs.
FilterInputStream.in
public void mark(int readlimit)
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.
mark in class
FilterInputStream
readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
FilterInputStream.in ,
reset()
public void reset()
throws IOException
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.
reset in class
FilterInputStream
IOException - if an I/O error occurs.
FilterInputStream.in ,
mark(int)