Class AutoCloseInputStream

  • All Implemented Interfaces:, java.lang.AutoCloseable
    Direct Known Subclasses:
    DbInputStream, LazyFileInputStream

    public class AutoCloseInputStream
    extends ProxyInputStream
    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.

    • Constructor Summary

      Constructor Description
      AutoCloseInputStream​( in)
      Creates an automatically closing proxy for the given input stream.
    • Constructor Detail

      • AutoCloseInputStream

        public AutoCloseInputStream​( in)
        Creates an automatically closing proxy for the given input stream.
        in - underlying input stream
    • Method Detail

      • close

        public void close()
        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.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface
        close in class ProxyInputStream
        Throws: - if the underlying input stream can not be closed