|
| |
|
| java.lang.Object
 java.io.InputStream
java.io.FilterInputStream
All known Subclasses: java.io.DataInputStream, java.util.zip.InflaterInputStream, java.security.DigestInputStream, java.io.PushbackInputStream, java.io.LineNumberInputStream, java.io.BufferedInputStream, java.util.zip.CheckedInputStream,
| FilterInputStream | | public class FilterInputStream extends InputStream (Code) | | 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.
See Also: FilterOutputStream |
| Field Summary | |
| protected InputStream | in
The target InputStream which is being filtered. |
| Method Summary | |
| public int | available()
Answers a int representing the number of bytes that are available before
this FilterInputStream will block. | | public void | close()
Close this FilterInputStream. | | public synchronized void | mark(int readlimit)
Set a Mark position in this FilterInputStream. | | public boolean | markSupported()
Answers a boolean indicating whether or not this FilterInputStream
supports mark() and reset(). | | public int | read()
Reads a single byte from this FilterInputStream and returns the result as
an int. | | public int | read(byte[] buffer)
Reads bytes from this FilterInputStream and stores them in byte array
buffer. | | 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. | | public synchronized void | reset()
Reset this FilterInputStream to the last marked location. | | 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. |
| FilterInputStream | | protected FilterInputStream(InputStream in)(Code) | | 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. |
| available | | public int available() throws IOException(Code) | | Answers 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.
the number of bytes available before blocking.
throws:
IOException - If an error occurs in this stream. |
| close | | public void close() throws IOException(Code) | | Close this FilterInputStream. This implementation closes the target
stream.
throws:
IOException - If an error occurs attempting to close this stream. |
| mark | | public synchronized void mark(int readlimit)(Code) | | 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 themark. |
| markSupported | | public boolean markSupported()(Code) | | Answers a boolean indicating whether or not this FilterInputStream
supports mark() and reset(). This implementation answers whether or not
the target stream supports marking.
true if mark() and reset() are supported,false otherwise. |
| read | | public int read() throws IOException(Code) | | 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.
the byte read or -1 if end of stream.
throws:
IOException - If the stream is already closed or another IOExceptionoccurs. |
| read | | public int read(byte[] buffer) throws IOException(Code) | | 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. the number of bytes actually read or -1 if end of stream.
throws:
IOException - If the stream is already closed or another IOExceptionoccurs. |
| read | | public int read(byte[] buffer, int offset, int count) throws IOException(Code) | | 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.
Parameters:
offset - the offset in buffer to store the read bytes.
Parameters:
count - the maximum number of bytes to store in buffer. the number of bytes actually read or -1 if end of stream.
throws:
IOException - If the stream is already closed or another IOExceptionoccurs. |
| reset | | public synchronized void reset() throws IOException(Code) | | 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 IOExceptionoccurs. |
| skip | | public long skip(long count) throws IOException(Code) | | 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. the number of bytes actually skipped.
throws:
IOException - If the stream is already closed or another IOExceptionoccurs. |
|
|
|