java.io
Class LineNumberInputStream

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.io.InputStream sample code for java.io.InputStream definition code for java.io.InputStream 
      extended by java.io.FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream 
          extended by java.io.LineNumberInputStream
All Implemented Interfaces:
Closeable sample code for java.io.Closeable definition code for java.io.Closeable

Deprecated. This class incorrectly assumes that bytes adequately represent characters. As of JDK 1.1, the preferred way to operate on character streams is via the new character-stream classes, which include a class for counting line numbers.

@Deprecated
public class LineNumberInputStream
extends FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream

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.

Since:
JDK1.0
See Also:
LineNumberReader sample code for java.io.LineNumberReader definition code for java.io.LineNumberReader

Field Summary
 
Fields inherited from class java.io.FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in
 
Constructor Summary
LineNumberInputStream sample code for java.io.LineNumberInputStream.LineNumberInputStream(java.io.InputStream) definition code for java.io.LineNumberInputStream.LineNumberInputStream(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  in)
          Deprecated. Constructs a newline number input stream that reads its input from the specified input stream.
 
Method Summary
 int available sample code for java.io.LineNumberInputStream.available() definition code for java.io.LineNumberInputStream.available() ()
          Deprecated. Returns the number of bytes that can be read from this input stream without blocking.
 int getLineNumber sample code for java.io.LineNumberInputStream.getLineNumber() definition code for java.io.LineNumberInputStream.getLineNumber() ()
          Deprecated. Returns the current line number.
 void mark sample code for java.io.LineNumberInputStream.mark(int) definition code for java.io.LineNumberInputStream.mark(int) (int readlimit)
          Deprecated. Marks the current position in this input stream.
 int read sample code for java.io.LineNumberInputStream.read() definition code for java.io.LineNumberInputStream.read() ()
          Deprecated. Reads the next byte of data from this input stream.
 int read sample code for java.io.LineNumberInputStream.read(byte[], int, int) definition code for java.io.LineNumberInputStream.read(byte[], int, int) (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 sample code for java.io.LineNumberInputStream.reset() definition code for java.io.LineNumberInputStream.reset() ()
          Deprecated. Repositions this stream to the position at the time the mark method was last called on this input stream.
 void setLineNumber sample code for java.io.LineNumberInputStream.setLineNumber(int) definition code for java.io.LineNumberInputStream.setLineNumber(int) (int lineNumber)
          Deprecated. Sets the line number to the specified argument.
 long skip sample code for java.io.LineNumberInputStream.skip(long) definition code for java.io.LineNumberInputStream.skip(long) (long n)
          Deprecated. Skips over and discards n bytes of data from this input stream.
 
Methods inherited from class java.io.FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
close sample code for java.io.FilterInputStream.close() definition code for java.io.FilterInputStream.close() , markSupported sample code for java.io.FilterInputStream.markSupported() definition code for java.io.FilterInputStream.markSupported() , read sample code for java.io.FilterInputStream.read(byte[]) definition code for java.io.FilterInputStream.read(byte[])
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

LineNumberInputStream sample code for java.io.LineNumberInputStream(java.io.InputStream) definition code for java.io.LineNumberInputStream(java.io.InputStream)

public LineNumberInputStream(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  in)
Deprecated. 
Constructs a newline number input stream that reads its input from the specified input stream.

Parameters:
in - the underlying input stream.
Method Detail

read sample code for java.io.LineNumberInputStream.read() definition code for java.io.LineNumberInputStream.read()

public int read()
         throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Deprecated. 
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.

Overrides:
read sample code for java.io.FilterInputStream.read() definition code for java.io.FilterInputStream.read() in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Returns:
the next byte of data, or -1 if the end of this stream is reached.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
FilterInputStream.in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in , getLineNumber() sample code for java.io.LineNumberInputStream.getLineNumber() definition code for java.io.LineNumberInputStream.getLineNumber()

read sample code for java.io.LineNumberInputStream.read(byte[], int, int) definition code for java.io.LineNumberInputStream.read(byte[], int, int)

public int read(byte[] b,
                int off,
                int len)
         throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Deprecated. 
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.

Overrides:
read sample code for java.io.FilterInputStream.read(byte[], int, int) definition code for java.io.FilterInputStream.read(byte[], int, int) in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Parameters:
b - the buffer into which the data is read.
off - the start offset of the data.
len - the maximum number of bytes read.
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.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
read() sample code for java.io.LineNumberInputStream.read() definition code for java.io.LineNumberInputStream.read()

skip sample code for java.io.LineNumberInputStream.skip(long) definition code for java.io.LineNumberInputStream.skip(long)

public long skip(long n)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Deprecated. 
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.

Overrides:
skip sample code for java.io.FilterInputStream.skip(long) definition code for java.io.FilterInputStream.skip(long) in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
FilterInputStream.in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in

setLineNumber sample code for java.io.LineNumberInputStream.setLineNumber(int) definition code for java.io.LineNumberInputStream.setLineNumber(int)

public void setLineNumber(int lineNumber)
Deprecated. 
Sets the line number to the specified argument.

Parameters:
lineNumber - the new line number.
See Also:
getLineNumber() sample code for java.io.LineNumberInputStream.getLineNumber() definition code for java.io.LineNumberInputStream.getLineNumber()

getLineNumber sample code for java.io.LineNumberInputStream.getLineNumber() definition code for java.io.LineNumberInputStream.getLineNumber()

public int getLineNumber()
Deprecated. 
Returns the current line number.

Returns:
the current line number.
See Also:
setLineNumber(int) sample code for java.io.LineNumberInputStream.setLineNumber(int) definition code for java.io.LineNumberInputStream.setLineNumber(int)

available sample code for java.io.LineNumberInputStream.available() definition code for java.io.LineNumberInputStream.available()

public int available()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Deprecated. 
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.

Overrides:
available sample code for java.io.FilterInputStream.available() definition code for java.io.FilterInputStream.available() in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Returns:
the number of bytes that can be read from this input stream without blocking.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
FilterInputStream.in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in

mark sample code for java.io.LineNumberInputStream.mark(int) definition code for java.io.LineNumberInputStream.mark(int)

public void mark(int readlimit)
Deprecated. 
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.

Overrides:
mark sample code for java.io.FilterInputStream.mark(int) definition code for java.io.FilterInputStream.mark(int) in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Parameters:
readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also:
FilterInputStream.in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in , reset() sample code for java.io.LineNumberInputStream.reset() definition code for java.io.LineNumberInputStream.reset()

reset sample code for java.io.LineNumberInputStream.reset() definition code for java.io.LineNumberInputStream.reset()

public void reset()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Deprecated. 
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.

Overrides:
reset sample code for java.io.FilterInputStream.reset() definition code for java.io.FilterInputStream.reset() in class FilterInputStream sample code for java.io.FilterInputStream definition code for java.io.FilterInputStream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
FilterInputStream.in sample code for java.io.FilterInputStream.in definition code for java.io.FilterInputStream.in , mark(int) sample code for java.io.LineNumberInputStream.mark(int) definition code for java.io.LineNumberInputStream.mark(int)