Package org.apache.commons.io.output

Class ClosedOutputStream

java.lang.Object

java.io.OutputStream

org.apache.commons.io.output.ClosedOutputStream

All Implemented Interfaces:

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

public class ClosedOutputStream
extends java.io.OutputStream

Throws an IOException on all attempts to write to the stream.

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

Since:

1.4

Field Summary

Fields

Modifier and Type	Field	Description
static ClosedOutputStream	CLOSED_OUTPUT_STREAM	Deprecated. Use INSTANCE.
static ClosedOutputStream	INSTANCE	The singleton instance.

Constructor Summary

Constructors

Constructor	Description
ClosedOutputStream()	Construct a new instance.

Method Summary

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

Methods inherited from class java.io.OutputStream

close, nullOutputStream, write

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ClosedOutputStream INSTANCE

The singleton instance.

Since:

2.12.0

CLOSED_OUTPUT_STREAM

@Deprecated
public static final ClosedOutputStream CLOSED_OUTPUT_STREAM

Deprecated.

Use INSTANCE.

The singleton instance.

Constructor Detail

ClosedOutputStream

public ClosedOutputStream()

Construct a new instance.

Method Detail

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

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException - always thrown

write

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

Throws an IOException to indicate that the stream is closed.

Overrides:

write in class java.io.OutputStream

Parameters:

b - Byte array, never null.

off - The start offset in the byte array.

len - The number of bytes to write.

Throws:

java.lang.NullPointerException - if the byte array is null.

java.lang.IndexOutOfBoundsException - if off or len are negative, or if off + len is greater than b.length.

java.io.IOException - always thrown.

write

public void write(int b)
           throws java.io.IOException

Throws an IOException to indicate that the stream is closed.

Specified by:

write in class java.io.OutputStream

Parameters:

b - ignored.

Throws:

java.io.IOException - always thrown.