org.apache.commons.io.output

Class ClosedWriter

java.lang.Object

java.io.Writer

org.apache.commons.io.output.ClosedWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class ClosedWriter
extends java.io.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 and Description
static ClosedWriter	CLOSED_WRITER Deprecated. Use INSTANCE.
static ClosedWriter	INSTANCE The singleton instance.

Constructor Summary

Constructors

Constructor and Description
ClosedWriter()

Method Summary

Modifier and Type	Method and 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 java.io.Writer

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

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

ClosedWriter

public ClosedWriter()

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws an IOException to indicate that the stream is closed.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - always thrown

write

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

Throws an IOException to indicate that the writer is closed.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - ignored

off - ignored

len - ignored

Throws:

java.io.IOException - always thrown