LineNumberInputStream JDK 1.6)

Methods

Hide/Show inherited methods

public int available () throws IOException [Overrides FilterInputStream]

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

public void close () throws IOException [Inherited From FilterInputStream]

Closes this input stream and releases any system resources associated with the stream.

Closes this input stream and releases any system resources
associated with the stream.
This
method simply performs in.close().
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in,

public int getLineNumber ()

Returns the current line number.

public void mark (int readlimit) [Overrides FilterInputStream]

Marks the current position in this input stream.

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 - the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also: FilterInputStream.in, LineNumberInputStream.reset(),

public boolean markSupported () [Inherited From FilterInputStream]

Tests if this input stream supports the mark and reset methods.

Tests if this input stream supports the mark
and reset methods.
This method
simply performs in.markSupported().
Returns: true if this stream type supports the mark and reset method; false otherwise.
See Also: FilterInputStream.in, InputStream.mark(int), InputStream.reset(),

public int read () throws IOException [Overrides FilterInputStream] [Specified in InputStream]

Reads the next byte of data from this input stream.

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: the next byte of data, or -1 if the end of this stream is reached.
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in, LineNumberInputStream.getLineNumber(),

public int read (byte[] b) throws IOException [Inherited From FilterInputStream]

Reads up to byte.length bytes of data from this input stream into an array of bytes.

Reads up to byte.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

This method simply performs the call read(b, 0, b.length) and returns the result. It is important that it does not do in.read(b) instead; certain subclasses of FilterInputStream depend on the implementation strategy actually used.
Returns: the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Parameters:
- b - the buffer into which the data is read.
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.read(byte[], int, int),

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

Reads up to len bytes of data from this input stream into an array of bytes.

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.
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.
Parameters:
- b - the buffer into which the data is read.
- off - the start offset of the data.
- len - the maximum number of bytes read.
Throws:
- IOException - if an I/O error occurs.
See Also: LineNumberInputStream.read(),

public void reset () throws IOException [Overrides FilterInputStream]

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.
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in, LineNumberInputStream.mark(int),

public void setLineNumber (int lineNumber)

Sets the line number to the specified argument.

public long skip (long n) throws IOException [Overrides FilterInputStream]

Skips over and discards n bytes of data from this input stream.

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.
Returns: the actual number of bytes skipped.
Parameters:
- n - the number of bytes to be skipped.
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in,