java.lang.Object | ||
↳ | java.io.InputStream | |
↳ | java.io.FilterInputStream |
Known Direct Subclasses |
Known Indirect Subclasses |
Wraps an existing InputStream
and performs some transformation on
the input data while it is being read. Transformations can be anything from a
simple byte-wise filtering input data to an on-the-fly compression or
decompression of the underlying stream. Input streams that wrap another input
stream and provide some additional functionality on top of it usually inherit
from this class.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
in | The source input stream that is filtered. |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new
FilterInputStream with the specified input
stream as source. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the number of bytes that are available before this stream will
block.
| |||||||||||
Closes this stream.
| |||||||||||
Sets a mark position in this stream.
| |||||||||||
Indicates whether this stream supports
mark() and reset() . | |||||||||||
Reads at most
count bytes from this stream and stores them in the
byte array buffer starting at offset . | |||||||||||
Reads bytes from this stream and stores them in the byte array
buffer . | |||||||||||
Reads a single byte from the filtered stream and returns it as an integer
in the range from 0 to 255.
| |||||||||||
Resets this stream to the last marked location.
| |||||||||||
Skips
count number of bytes in this stream. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class java.io.InputStream
| |||||||||||
From class java.lang.Object
| |||||||||||
From interface java.io.Closeable
|
Constructs a new FilterInputStream
with the specified input
stream as source.
in | the non-null InputStream to filter reads on. |
---|
Returns the number of bytes that are available before this stream will block.
IOException | if an error occurs in this stream. |
---|
Closes this stream. This implementation closes the filtered stream.
IOException | if an error occurs while closing this stream. |
---|
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.
This implementation sets a mark in the filtered stream.
readlimit | the number of bytes that can be read from this stream before the mark is invalidated. |
---|
Indicates whether this stream supports mark()
and reset()
.
This implementation returns whether or not the filtered stream supports
marking.
true
if mark()
and reset()
are supported,
false
otherwise.Reads at most count
bytes from this 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. This implementation reads bytes from the
filtered stream.
buffer | the byte array in which to store the bytes read. |
---|---|
offset | the initial position in buffer to store the bytes
read from this stream. |
count | the maximum number of bytes to store in buffer . |
IOException | if this stream is closed or another I/O error occurs. |
---|
Reads bytes from this stream and stores them in the byte array
buffer
. Returns the number of bytes actually read or -1 if no
bytes were read and the end of this stream was encountered. This
implementation reads bytes from the filtered stream.
buffer | the byte array in which to store the read bytes. |
---|
IOException | if this stream is closed or another IOException occurs. |
---|
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.
IOException | if the stream is closed or another IOException occurs. |
---|
Resets this stream to the last marked location. This implementation resets the target stream.
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. |
---|
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.
count | the number of bytes to skip. |
---|
IOException | if this stream is closed or another IOException occurs. |
---|