OpenJDK 1.22 · java.io.LineNumberInputStream · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv int	lineNumber
pack-priv int	markLineNumber
pack-priv int	markPushBack
pack-priv int	pushBack

Access	Constructor and Description
public	LineNumberInputStream(InputStream the underlying input stream. in) Constructs a newline number input stream that reads its input from the specified input stream.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the number of bytes that can be read from this input stream without blocking. available() Overrides java.io.FilterInputStream.available. Returns the number of bytes that can be read from this input stream without blocking.
public int	Returns: the current line number. getLineNumber() Returns the current line number.
public void	mark(int the maximum limit of bytes that can be read before the mark position becomes invalid. readlimit) Overrides java.io.FilterInputStream.mark. Marks the current position in this input stream.
public int	Returns: the next byte of data, or `-1` if the end of this stream is reached. read() Overrides java.io.FilterInputStream.read. Reads the next byte of data from this input stream.
public int	Returns: the total number of bytes read into the buffer, or `-1` if there is no more data because the end of this stream has been reached. read(byte[] the buffer into which the data is read. b, int the start offset of the data. off, int the maximum number of bytes read. len) Overrides java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public void	reset() Overrides java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.
public void	setLineNumber(int the new line number. lineNumber) Sets the line number to the specified argument.
public long	Returns: the actual number of bytes skipped. skip(long the number of bytes to be skipped. n) Overrides java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from java.io.FilterInputStream:: close markSupported read

lineNumber	back to summary
pack-priv int lineNumber

markLineNumber	back to summary
pack-priv int markLineNumber

markPushBack	back to summary
pack-priv int markPushBack

pushBack	back to summary
pack-priv int pushBack

LineNumberInputStream	back to summary
public LineNumberInputStream(InputStream in) Constructs a newline number input stream that reads its input from the specified input stream. Parameters in:InputStream the underlying input stream.

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.FilterInputStream.available. 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. Returns:int the number of bytes that can be read from this input stream without blocking. Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`

public int available() throws IOException

Overrides java.io.FilterInputStream.available.

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.

Returns:int

the number of bytes that can be read from this input stream without blocking.

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.FilterInputStream#in

getLineNumber back to summary

getLineNumber	back to summary
public int getLineNumber() Returns the current line number. Returns:int the current line number. See Also `setLineNumber`

public int getLineNumber()

Returns the current line number.

Returns:int: the current line number.
See Also: setLineNumber

mark back to summary

mark	back to summary
public void mark(int readlimit) Overrides java.io.FilterInputStream.mark. 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:int the maximum limit of bytes that can be read before the mark position becomes invalid. See Also `java.io.FilterInputStream#in`, `java.io.LineNumberInputStream#reset()`

public void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

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:int: the maximum limit of bytes that can be read before the mark position becomes invalid.

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. 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. Returns:int the next byte of data, or `-1` if the end of this stream is reached. Annotations @SuppressWarnings:fallthrough Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`, `java.io.LineNumberInputStream#getLineNumber()`

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

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.

Returns:int

the next byte of data, or -1 if the end of this stream is reached.

Annotations

@SuppressWarnings:fallthrough

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. 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:byte[] the buffer into which the data is read. off:int the start offset of the data. len:int the maximum number of bytes read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of this stream has been reached. Exceptions IOException: if an I/O error occurs. See Also `java.io.LineNumberInputStream#read()`

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterInputStream.read.

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:byte[]: the buffer into which the data is read.
off:int: the start offset of the data.
len:int: the maximum number of bytes read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of this stream has been reached.

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.LineNumberInputStream#read()

reset back to summary

reset	back to summary
public void reset() throws IOException Overrides java.io.FilterInputStream.reset. 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. Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`, `java.io.LineNumberInputStream#mark(int)`

public void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

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.

Exceptions

IOException:: if an I/O error occurs.

setLineNumber back to summary

setLineNumber	back to summary
public void setLineNumber(int lineNumber) Sets the line number to the specified argument. Parameters lineNumber:int the new line number. See Also `getLineNumber`

public void setLineNumber(int lineNumber)

Sets the line number to the specified argument.

Parameters

lineNumber:int: the new line number.

See Also

getLineNumber

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. 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:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped. Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

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:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.FilterInputStream#in

public Class LineNumberInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail