eve.io

Class NullOutputStream

java.lang.Object

java.io.OutputStream

eve.io.NullOutputStream

public class NullOutputStream
extends OutputStream

Author:

Michael L Brereton

Constructor Summary

Constructors

Constructor and Description
NullOutputStream(boolean returnError) Create a NullOutputStream that will either always throw an IOException or will always ignore writes.

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the stream.
void	flush() This method forces any data that may have been buffered to be written to the underlying output device.
void	write(byte[] src, int offset, int count) This method writes len bytes from the specified array b starting at index off into the array.
void	write(int ch) This method writes a single byte to the output stream.

Methods inherited from class java.io.OutputStream

finalize, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NullOutputStream

public NullOutputStream(boolean returnError)

Create a NullOutputStream that will either always throw an IOException or will always ignore writes.

Parameters:

returnError - if this is true any attempted write will throw an IOException, otherwise it will be ignored.

Method Detail

write

public void write(int ch)
           throws IOException

Description copied from class: OutputStream

This method writes a single byte to the output stream. The byte written is the low eight bits of the int passed as the argument.

Subclasses must provide an implementation of this method.

Overrides:

write in class OutputStream

Parameters:

ch - The byte to be written to the output stream, passed as the low eight bits of an int

Throws:

IOException - If an error occurs

write

public void write(byte[] src,
                  int offset,
                  int count)
           throws IOException

Description copied from class: OutputStream

This method writes len bytes from the specified array b starting at index off into the array.

This method in this class calls the single byte write() method in a loop until all bytes have been written. Subclasses should override this method if possible in order to provide a more efficent implementation.

Overrides:

write in class OutputStream

Parameters:

src - The array of bytes to write from

offset - The index into the array to start writing from

count - The number of bytes to write

Throws:

IOException - If an error occurs

flush

public void flush()
           throws IOException

Description copied from class: OutputStream

This method forces any data that may have been buffered to be written to the underlying output device. Please note that the host environment might perform its own buffering unbeknowst to Java. In that case, a write made (for example, to a disk drive) might be cached in OS buffers instead of actually being written to disk.

This method in this class does nothing.

Overrides:

flush in class OutputStream

Throws:

IOException - If an error occurs

close

public void close()
           throws IOException

Description copied from class: OutputStream

This method closes the stream. Any internal or native resources associated with this stream are freed. Any subsequent attempt to access the stream might throw an exception.

This method in this class does nothing.

Overrides:

close in class OutputStream

Throws:

IOException - If an error occurs