Package org.opends.server.types

Class NullOutputStream

java.lang.Object

java.io.OutputStream

org.opends.server.types.NullOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class NullOutputStream
extends OutputStream

This class defines a custom output stream that simply discards any data written to it.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the output stream.
void	flush()	Flushes the output stream.
static NullOutputStream	instance()	Retrieves an instance of this null output stream.
static PrintStream	nullPrintStream()	Retrieves a print stream using this null output stream.
static PrintStream	wrapOrNullStream(OutputStream s)	Returns s wrapped into a PrintStream if is not null, nullPrintStream() otherwise.
void	write(byte[] b)	Writes the provided data to this output stream.
void	write(byte[] b, int off, int len)	Writes the provided data to this output stream.
void	write(int b)	Writes the provided byte to this output stream.

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static NullOutputStream instance()

Retrieves an instance of this null output stream.

Returns:

An instance of this null output stream.

nullPrintStream

public static PrintStream nullPrintStream()

Retrieves a print stream using this null output stream.

Returns:

A print stream using this null output stream.

wrapOrNullStream

public static PrintStream wrapOrNullStream(OutputStream s)

Returns s wrapped into a PrintStream if is not null, nullPrintStream() otherwise.

Parameters:

s - the OutputStream to wrap into a PrintStream. Can be null.

Returns:

a PrintStream wrapping s if not null, nullPrintStream() otherwise.

close

public void close()

Closes the output stream. This has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

flush

public void flush()

Flushes the output stream. This has no effect.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

write

public void write(byte[] b)

Writes the provided data to this output stream. This has no effect.

Overrides:

write in class OutputStream

Parameters:

b - The byte array containing the data to be written.

write

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

Writes the provided data to this output stream. This has no effect.

Overrides:

write in class OutputStream

Parameters:

b - The byte array containing the data to be written.

off - The offset at which the real data begins.

len - The number of bytes to be written.

write

public void write(int b)

Writes the provided byte to this output stream. This has no effect.

Specified by:

write in class OutputStream

Parameters:

b - The byte to be written.