Class CloseShieldOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

    public class CloseShieldOutputStream
    extends ProxyOutputStream
    Proxy stream that prevents the underlying output stream from being closed.

    This class is typically used in cases where an output stream needs to be passed to a component that wants to explicitly close the stream even if other components would still use the stream for output.

    Since:
    1.4
    • Field Summary

      • Fields inherited from class java.io.FilterOutputStream

        out
    • Constructor Summary

      Constructors 
      Constructor Description
      CloseShieldOutputStream​(java.io.OutputStream outputStream)
      Deprecated.
      Using this constructor prevents IDEs from warning if the underlying output stream is never closed.
    • Constructor Detail

      • CloseShieldOutputStream

        @Deprecated
        public CloseShieldOutputStream​(java.io.OutputStream outputStream)
        Deprecated.
        Using this constructor prevents IDEs from warning if the underlying output stream is never closed. Use wrap(OutputStream) instead.
        Creates a proxy that shields the given output stream from being closed.
        Parameters:
        outputStream - underlying output stream
    • Method Detail

      • wrap

        public static CloseShieldOutputStream wrap​(java.io.OutputStream outputStream)
        Creates a proxy that shields the given output stream from being closed.
        Parameters:
        outputStream - the output stream to wrap
        Returns:
        the created proxy
        Since:
        2.9.0
      • close

        public void close()
        Replaces the underlying output stream with a ClosedOutputStream sentinel. The original output stream will remain open, but this proxy will appear closed.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class ProxyOutputStream