public class

LineNumberInputStream

extends FilterInputStream
java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.FilterInputStream
       ↳ java.io.LineNumberInputStream

This class is deprecated.
Use LineNumberReader

Class Overview

Wraps an existing InputStream and counts the line terminators encountered while reading the data. Line numbering starts at 0. Recognized line terminator sequences are '\r', '\n' and "\r\n". When using read, line terminator sequences are always translated into '\n'.

Summary

[Expand]
Inherited Fields
From class java.io.FilterInputStream
Public Constructors
LineNumberInputStream(InputStream in)
Constructs a new LineNumberInputStream on the InputStream in.
Public Methods
int available()
Returns the number of bytes that are available before this stream will block.
int getLineNumber()
Returns the current line number for this stream.
void mark(int readlimit)
Sets a mark position in this stream.
int read(byte[] buffer, int offset, int length)
Reads at most length bytes from the filtered stream and stores them in the byte array buffer starting at offset.
int read()
Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255.
void reset()
Resets this stream to the last marked location.
void setLineNumber(int lineNumber)
Sets the line number of this stream to the specified lineNumber.
long skip(long count)
Skips count number of bytes in this stream.
[Expand]
Inherited Methods
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public LineNumberInputStream (InputStream in)

Since: API Level 1

Constructs a new LineNumberInputStream on the InputStream in. Line numbers are counted for all data read from this stream.

Parameters
in The non-null input stream to count line numbers.

Public Methods

public int available ()

Since: API Level 1

Returns the number of bytes that are available before this stream will block.

Note: The source stream may just be a sequence of "\r\n" bytes which are converted into '\n' by this stream. Therefore, available returns only in.available() / 2 bytes as result.

Returns
  • the guaranteed number of bytes available before blocking.
Throws
IOException if an error occurs in this stream.

public int getLineNumber ()

Since: API Level 1

Returns the current line number for this stream. Numbering starts at 0.

Returns
  • the current line number.

public void mark (int readlimit)

Since: API Level 1

Sets a mark position in this stream. The parameter readlimit indicates how many bytes can be read before the mark is invalidated. Sending reset() will reposition this stream back to the marked position, provided that readlimit has not been surpassed. The line number count will also be reset to the last marked line number count.

This implementation sets a mark in the filtered stream.

Parameters
readlimit the number of bytes that can be read from this stream before the mark is invalidated.
See Also

public int read (byte[] buffer, int offset, int length)

Since: API Level 1

Reads at most length bytes from the filtered stream and stores them in the byte array buffer starting at offset. Returns the number of bytes actually read or -1 if no bytes have been read and the end of this stream has been reached.

The line number count is incremented if a line terminator is encountered. Recognized line terminator sequences are '\r', '\n' and "\r\n". Line terminator sequences are always translated into '\n'.

Parameters
buffer the array in which to store the bytes read.
offset the initial position in buffer to store the bytes read from this stream.
length the maximum number of bytes to store in buffer.
Returns
  • the number of bytes actually read or -1 if the end of the filtered stream has been reached while reading.
Throws
IndexOutOfBoundsException if offset < 0 or length < 0, or if offset + length is greater than the length of buffer.
IOException if this stream is closed or another IOException occurs.
NullPointerException if buffer is null.

public int read ()

Since: API Level 1

Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of this stream has been reached.

The line number count is incremented if a line terminator is encountered. Recognized line terminator sequences are '\r', '\n' and "\r\n". Line terminator sequences are always translated into '\n'.

Returns
  • the byte read or -1 if the end of the filtered stream has been reached.
Throws
IOException if the stream is closed or another IOException occurs.

public void reset ()

Since: API Level 1

Resets this stream to the last marked location. It also resets the line count to what is was when this stream was marked.

Throws
IOException if this stream is already closed, no mark has been set or the mark is no longer valid because more than readlimit bytes have been read since setting the mark.
See Also

public void setLineNumber (int lineNumber)

Since: API Level 1

Sets the line number of this stream to the specified lineNumber. Note that this may have side effects on the line number associated with the last marked position.

Parameters
lineNumber the new lineNumber value.
See Also

public long skip (long count)

Since: API Level 1

Skips count number of bytes in this stream. Subsequent read()'s will not return these bytes unless reset() is used. This implementation skips count number of bytes in the filtered stream and increments the line number count whenever line terminator sequences are skipped.

Parameters
count the number of bytes to skip.
Returns
  • the number of bytes actually skipped.
Throws
IOException if this stream is closed or another IOException occurs.
See Also