java.io.FilterInputStream
FilteredInputStream is a class which takes an input stream and
filters the input in some way. The filtered view may be a buffered
view or one which uncompresses data before returning bytes read.
FilterInputStreams are meant for byte streams.
Known Direct Subclasses
Known Indirect Subclasses
Summary
Fields
protected |
|
|
InputStream |
in |
The target InputStream which is being filtered. |
Protected Constructors
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Fields
The target InputStream which is being filtered.
Protected Constructors
protected
FilterInputStream(InputStream in)
Constructs a new FilterInputStream on the InputStream
in
.
All reads are now filtered through this stream.
Parameters
in
| The non-null InputStream to filter reads on.
|
Public Methods
public
int
available()
Returns a int representing the number of bytes that are available before
this FilterInputStream will block. This method returns the number of
bytes available in the target stream.
Returns
- the number of bytes available before blocking.
public
void
close()
Close this FilterInputStream. This implementation closes the target
stream.
Throws
IOException
| If an error occurs attempting to close this stream.
|
public
synchronized
void
mark(int readlimit)
Set a Mark position in this FilterInputStream. The parameter
readLimit
indicates how many bytes can be read before a
mark is invalidated. Sending reset() will reposition the Stream back to
the marked position provided
readLimit
has not been
surpassed.
This implementation sets a mark in the target stream.
Parameters
readlimit
| the number of bytes to be able to read before invalidating the
mark.
|
public
boolean
markSupported()
Returns a boolean indicating whether or not this FilterInputStream
supports mark() and reset(). This implementation returns whether or not
the target stream supports marking.
Returns
true
if mark() and reset() are supported,
false
otherwise.
public
int
read(byte[] buffer, int offset, int count)
Reads at most
count
bytes from this FilterInputStream and
stores them in byte array
buffer
starting at
offset
. Answer the number of bytes actually read or -1 if
no bytes were read and end of stream was encountered. This implementation
reads bytes from the target stream.
Parameters
buffer
| the byte array in which to store the read bytes. |
offset
| the offset in buffer to store the read bytes. |
count
| the maximum number of bytes to store in buffer . |
Returns
- the number of bytes actually read or -1 if end of stream.
Throws
IOException
| If the stream is already closed or another IOException
occurs.
|
public
int
read(byte[] buffer)
Reads bytes from this FilterInputStream and stores them in byte array
buffer
. Answer the number of bytes actually read or -1 if
no bytes were read and end of stream was encountered. This implementation
reads bytes from the target stream.
Parameters
buffer
| the byte array in which to store the read bytes. |
Returns
- the number of bytes actually read or -1 if end of stream.
Throws
IOException
| If the stream is already closed or another IOException
occurs.
|
public
int
read()
Reads a single byte from this FilterInputStream and returns the result as
an int. The low-order byte is returned or -1 of the end of stream was
encountered. This implementation returns a byte from the target stream.
Returns
- the byte read or -1 if end of stream.
Throws
IOException
| If the stream is already closed or another IOException
occurs.
|
public
synchronized
void
reset()
Reset this FilterInputStream to the last marked location. If the
readlimit
has been passed or no
mark
has
been set, throw IOException. This implementation resets the target
stream.
Throws
IOException
| If the stream is already closed or another IOException
occurs.
|
public
long
skip(long count)
Skips
count
number of bytes in this InputStream.
Subsequent
read()
's will not return these bytes unless
reset()
is used. This implementation skips
count
number of bytes in the target stream.
Parameters
count
| the number of bytes to skip. |
Returns
- the number of bytes actually skipped.
Throws
IOException
| If the stream is already closed or another IOException
occurs.
|