java.io
Class LineNumberInputStream

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

All Implemented Interfaces:

Closeable

Deprecated. Use LineNumberReader

@Deprecated
public class LineNumberInputStream
extends FilterInputStream

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'.

Since:

Android 1.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

LineNumberInputStream(InputStream in)
Deprecated. Constructs a new LineNumberInputStream on the InputStream in.

Method Summary

int	available() Deprecated. Returns the number of bytes that are available before this stream will block.
int	getLineNumber() Deprecated. Returns the current line number for this stream.
void	mark(int readlimit) Deprecated. Sets a mark position in this stream.
int	read() Deprecated. Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int offset, int length) Deprecated. Reads at most length bytes from the filtered stream and stores them in the byte array buffer starting at offset.
void	reset() Deprecated. Resets this stream to the last marked location.
void	setLineNumber(int lineNumber) Deprecated. Sets the line number of this stream to the specified lineNumber.
long	skip(long count) Deprecated. Skips count number of bytes in this stream.

Methods inherited from class java.io.FilterInputStream

close, markSupported, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineNumberInputStream

public LineNumberInputStream(InputStream in)

Deprecated.

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.

Since:

Android 1.0

Method Detail

available

public int available()
              throws IOException

Deprecated.

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.

Overrides:

available in class FilterInputStream

Returns:

the guaranteed number of bytes available before blocking.

Throws:

IOException - if an error occurs in this stream.

Since:

Android 1.0

getLineNumber

public int getLineNumber()

Deprecated.

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

Returns:

the current line number.

Since:

Android 1.0

mark

public void mark(int readlimit)

Deprecated.

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.

Overrides:

mark in class FilterInputStream

Parameters:

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

Since:

Android 1.0

See Also:

FilterInputStream.markSupported(), reset()

read

public int read()
         throws IOException

Deprecated.

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'.

Overrides:

read in class FilterInputStream

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.

Since:

Android 1.0

read

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

Deprecated.

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'.

Overrides:

read in class FilterInputStream

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.

Since:

Android 1.0

reset

public void reset()
           throws IOException

Deprecated.

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

Overrides:

reset in class FilterInputStream

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.

Since:

Android 1.0

See Also:

mark(int), FilterInputStream.markSupported()

setLineNumber

public void setLineNumber(int lineNumber)

Deprecated.

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.

Since:

Android 1.0

See Also:

mark(int), reset()

skip

public long skip(long count)
          throws IOException

Deprecated.

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.

Overrides:

skip in class FilterInputStream

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.

Since:

Android 1.0

See Also:

mark(int), read(), reset()