org.apache.commons.io.input
public class AutoCloseInputStream extends ProxyInputStream
This class is typically used to release any resources related to an open stream as soon as possible even if the client application (by not explicitly closing the stream when no longer needed) or the underlying stream (by not releasing resources once the last byte has been read) do not do that.
Since: Commons IO 1.4
Version: $Id: AutoCloseInputStream.java 610010 2008-01-08 14:50:59Z niallp $
Constructor Summary | |
---|---|
AutoCloseInputStream(InputStream in)
Creates an automatically closing proxy for the given input stream.
|
Method Summary | |
---|---|
void | close()
Closes the underlying input stream and replaces the reference to it
with a ClosedInputStream instance.
|
protected void | finalize()
Ensures that the stream is closed before it gets garbage-collected.
|
int | read()
Reads and returns a single byte from the underlying input stream.
|
int | read(byte[] b)
Reads and returns bytes from the underlying input stream to the given
buffer. |
int | read(byte[] b, int off, int len)
Reads and returns bytes from the underlying input stream to the given
buffer. |
Parameters: in underlying input stream
This method is automatically called by the read methods when the end of input has been reached.
Note that it is safe to call this method any number of times. The original underlying input stream is closed and discarded only once when this method is first called.
Throws: IOException if the underlying input stream can not be closed
Throws: Throwable if an error occurs
Returns: next byte in the stream, or -1 if no more bytes are available
Throws: IOException if the stream could not be read or closed
Parameters: b buffer to which bytes from the stream are written
Returns: number of bytes read, or -1 if no more bytes are available
Throws: IOException if the stream could not be read or closed
Parameters: b buffer to which bytes from the stream are written off start offset within the buffer len maximum number of bytes to read
Returns: number of bytes read, or -1 if no more bytes are available
Throws: IOException if the stream could not be read or closed