Class ClosedWriter

java.lang.Object

java.io.Writer

org.apache.commons.io.output.ClosedWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ClosedWriter
extends Writer

Throws an IOException on all attempts to write with close() implemented as a noop.

Typically uses of this class include testing for corner cases in methods that accept a writer and acting as a sentinel value instead of a null writer.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field	Description
static final ClosedWriter	CLOSED_WRITER	Deprecated. Use INSTANCE.
static final ClosedWriter	INSTANCE	The singleton instance.

Fields inherited from class Writer

lock

Constructor Summary

Constructors

Constructor	Description
ClosedWriter()	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()	Throws an IOException to indicate that the stream is closed.
void	write(char[] cbuf, int off, int len)	Throws an IOException to indicate that the writer is closed.

Methods inherited from class Writer

append, append, append, write, write, write, write

Methods inherited from class Object

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

Field Details

INSTANCE

public static final ClosedWriter INSTANCE

The singleton instance.

Since:

2.12.0

CLOSED_WRITER

@Deprecated
public static final ClosedWriter CLOSED_WRITER

Deprecated.

Use INSTANCE.

The singleton instance.

Constructor Details

ClosedWriter

public ClosedWriter()

Construct a new instance.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Throws an IOException to indicate that the stream is closed.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - always thrown

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Throws an IOException to indicate that the writer is closed.

Specified by:

write in class Writer

Parameters:

cbuf - ignored.

off - ignored.

len - ignored.

Throws:

IOException - always thrown.