public class AutoCloseInputStream extends ProxyInputStreamProxy 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.
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description
afterRead(int n)Automatically closes the stream if the end of stream was reached.
close()Closes the underlying input stream and replaces the reference to it with a
finalize()Ensures that the stream is closed before it gets garbage-collected.
Methods inherited from class org.apache.commons.io.input.ProxyInputStream
available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip
public AutoCloseInputStream(InputStream in)Creates an automatically closing proxy for the given input stream.
in- underlying input stream
public void close() throws IOExceptionCloses the underlying input stream and replaces the reference to it with a
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.
protected void afterRead(int n) throws IOExceptionAutomatically closes the stream if the end of stream was reached.
Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.