Class NullOutputStream

java.lang.Object

java.io.OutputStream

org.apache.commons.io.output.NullOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class NullOutputStream
extends OutputStream

Never writes data. Calls never go beyond this class.

This output stream has no destination and all bytes written to it are ignored.

Field Summary

Fields

Modifier and Type	Field	Description
static final NullOutputStream	INSTANCE	The singleton instance.
static final NullOutputStream	NULL_OUTPUT_STREAM	Deprecated. Use INSTANCE.

Constructor Summary

Constructors

Constructor	Description
NullOutputStream()	Deprecated. Use INSTANCE.

Method Summary

Modifier and Type	Method	Description
void	write(byte[] b)	Does nothing.
void	write(byte[] b, int off, int len)	No-op operation.
void	write(int b)	Does nothing.

Methods inherited from class OutputStream

close, flush

Methods inherited from class Object

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

Field Details

INSTANCE

public static final NullOutputStream INSTANCE

The singleton instance.

Since:

2.12.0

NULL_OUTPUT_STREAM

@Deprecated
public static final NullOutputStream NULL_OUTPUT_STREAM

Deprecated.

Use INSTANCE.

The singleton instance.

Constructor Details

NullOutputStream

@Deprecated
public NullOutputStream()

Deprecated.

Use INSTANCE.

Deprecated in favor of INSTANCE.

TODO: Will be private in 3.0.

Method Details

write

public void write(byte[] b)
           throws IOException

Does nothing.

Overrides:

write in class OutputStream

Parameters:

b - The This method ignores this parameter.

Throws:

IOException - This method never throws any exceptions.

write

public void write(byte[] b,
 int off,
 int len)

No-op operation.

Validates the arguments but does not write the data.

Overrides:

write in class OutputStream

Parameters:

b - The byte array to write from, not null.

off - The offset to start at.

len - The number of bytes to write.

Throws:

NullPointerException - If b is null.

IndexOutOfBoundsException - If off or len are negative, off + len is greater than b.length.

write

public void write(int b)

Does nothing.

Specified by:

write in class OutputStream

Parameters:

b - This method ignores this parameter.