Creates a <code>FilterInputStream</code> by assigning the argument <code>inputStream</code> to the field <code>this.inputStream</code> so as to remember it for later use.
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. <p> This method returns the result of {@link #inputStream inputStream}.available().
Closes this input stream and releases any system resources associated with the stream. This method simply performs <code>inputStream.close()</code>.
Marks the current position in this input stream. A subsequent call to the <code>reset</code> method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. <p> The <code>readlimit</code> argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated. <p> This method simply performs <code>inputStream.mark(readlimit)</code>.
Tests if this input stream supports the <code>mark</code> and <code>reset</code> methods. This method simply performs <code>inputStream.markSupported()</code>.
Reads the next byte of data from this input stream. The value byte is returned as an <code>int</code> in the range <code>0</code> to <code>255</code>. If no byte is available because the end of the stream has been reached, the value <code>-1</code> is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. <p> This method simply performs <code>inputStream.read()</code> and returns the result.
Reads up to <code>b.length</code> bytes of data from this input stream into an array of bytes. This method blocks until some input is available. <p> This method simply performs the call <code>read(b, 0, b.length)</code> and returns the result. It is important that it does <i>not</i> do <code>inputStream.read(b)</code> instead; certain subclasses of <code>FilterInputStream</code> depend on the implementation strategy actually used.
Reads up to <code>len</code> bytes of data from this input stream into an array of bytes. If <code>len</code> is not zero, the method blocks until some input is available; otherwise, no bytes are read and <code>0</code> is returned. <p> This method simply performs <code>inputStream.read(b, off, len)</code> and returns the result.
Repositions this stream to the position at the time the <code>mark</code> method was last called on this input stream. <p> This method simply performs <code>inputStream.reset()</code>. <p> 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 parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.
Skips over and discards <code>n</code> bytes of data from the input stream. The <code>skip</code> method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly <code>0</code>. The actual number of bytes skipped is returned. <p> This method simply performs <code>inputStream.skip(n)</code>.
The input stream to be filtered.
Reads the next byte of data from the input stream. The value byte is returned as an <code>int</code> in the range <code>0</code> to <code>255</code>. If no byte is available because the end of the stream has been reached, the value <code>-1</code> is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
Reads some number of bytes from the input stream and stores them into the buffer array <code>b</code>. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.
Reads up to <code>len</code> bytes of data from the input stream into an array of bytes. An attempt is made to read as many as <code>len</code> bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.
Skips over and discards <code>n</code> bytes of data from this input stream. The <code>skip</code> method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly <code>0</code>. This may result from any of a number of conditions; reaching end of file before <code>n</code> bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If {@code n} is negative, the {@code skip} method for class {@code InputStream} always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.
Closes this input stream and releases any system resources associated with the stream.
Marks the current position in this input stream. A subsequent call to the <code>reset</code> method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.
Repositions this stream to the position at the time the <code>mark</code> method was last called on this input stream.
set a new position
Tests if this input stream supports the <code>mark</code> and <code>reset</code> methods. Whether or not <code>mark</code> and <code>reset</code> are supported is an invariant property of a particular input stream instance. The <code>markSupported</code> method of <code>InputStream</code> returns <code>false</code>.
A <code>FilterInputStream</code> contains some other input stream, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class <code>FilterInputStream</code> itself simply overrides all methods of <code>InputStream</code> with versions that pass all requests to the contained input stream. Subclasses of <code>FilterInputStream</code> may further override some of these methods and may also provide additional methods and fields.
@author Jonathan Payne