org.apache.commons.io.input
Class AutoCloseInputStream
public class AutoCloseInputStream
Proxy stream that closes and discards the underlying stream as soon as the
end of input has been reached or when the stream is explicitly closed.
Not even a reference to the underlying stream is kept after it has been
closed, so any allocated in-memory buffers can be freed even if the
client application still keeps a reference to the proxy stream.
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.
$Id: AutoCloseInputStream.java 610010 2008-01-08 14:50:59Z niallp $AutoCloseInputStream(InputStream in) - Creates an automatically closing proxy for the given input stream.
|
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.
|
AutoCloseInputStream
public AutoCloseInputStream(InputStream in)
Creates an automatically closing proxy for the given input stream.
in
- underlying input stream
close
public void close()
throws IOException
Closes the underlying input stream and replaces the reference to it
with a
ClosedInputStream
instance.
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.
- close in interface ProxyInputStream
finalize
protected void finalize()
throws Throwable
Ensures that the stream is closed before it gets garbage-collected.
As mentioned in
close()
, this is a no-op if the stream has
already been closed.
read
public int read()
throws IOException
Reads and returns a single byte from the underlying input stream.
If the underlying stream returns -1, the
close()
method is
called to automatically close and discard the stream.
- read in interface ProxyInputStream
- next byte in the stream, or -1 if no more bytes are available
read
public int read(byte[] b)
throws IOException
Reads and returns bytes from the underlying input stream to the given
buffer. If the underlying stream returns -1, the
close()
method
i called to automatically close and discard the stream.
- read in interface ProxyInputStream
b
- buffer to which bytes from the stream are written
- number of bytes read, or -1 if no more bytes are available
read
public int read(byte[] b,
int off,
int len)
throws IOException
Reads and returns bytes from the underlying input stream to the given
buffer. If the underlying stream returns -1, the
close()
method
i called to automatically close and discard the stream.
- read in interface ProxyInputStream
b
- buffer to which bytes from the stream are writtenoff
- start offset within the bufferlen
- maximum number of bytes to read
- number of bytes read, or -1 if no more bytes are available
Copyright (c) 2002-2008 Apache Software Foundation