Package org.apache.commons.io.output

Class CloseShieldWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

org.apache.commons.io.output.ProxyWriter

org.apache.commons.io.output.CloseShieldWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CloseShieldWriter
extends ProxyWriter

Proxy stream that prevents the underlying writer from being closed.

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

Since:

2.7

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
CloseShieldWriter(Writer out)	Creates a proxy that shields the given writer from being closed.

Method Summary

Modifier and Type	Method	Description
void	close()	Replaces the underlying writer with a ClosedWriter sentinel.

Methods inherited from class org.apache.commons.io.output.ProxyWriter

afterWrite, append, append, append, beforeWrite, flush, handleIOException, write, write, write, write, write

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CloseShieldWriter

public CloseShieldWriter(Writer out)

Creates a proxy that shields the given writer from being closed.

Parameters:

out - underlying writer

Method Details

close

public void close()

Replaces the underlying writer with a ClosedWriter sentinel. The original writer will remain open, but this proxy will appear closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ProxyWriter