Package org.apache.commons.io.output
Class CloseShieldOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- org.apache.commons.io.output.ProxyOutputStream
-
- org.apache.commons.io.output.CloseShieldOutputStream
-
- All Implemented Interfaces:
Closeable
,Flushable
,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
-
-
Constructor Summary
Constructors Constructor Description CloseShieldOutputStream(OutputStream out)
Creates a proxy that shields the given output stream from being closed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Replaces the underlying output stream with aClosedOutputStream
sentinel.-
Methods inherited from class org.apache.commons.io.output.ProxyOutputStream
flush, write, write, write
-
Methods inherited from class java.io.OutputStream
nullOutputStream
-
-
-
-
Constructor Detail
-
CloseShieldOutputStream
public CloseShieldOutputStream(OutputStream out)
Creates a proxy that shields the given output stream from being closed.- Parameters:
out
- underlying output stream
-
-
Method Detail
-
close
public void close()
Replaces the underlying output stream with aClosedOutputStream
sentinel. The original output stream will remain open, but this proxy will appear closed.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classProxyOutputStream
-
-