java.io

Class OutputStream

java.lang.Object

java.io.OutputStream

Direct Known Subclasses:

ByteArrayOutputStream, ChunkedDataOutputStream, FileOutputStream, FilterOutputStream, NullOutputStream

public abstract class OutputStream
extends Object

This abstract class forms the base of the hierarchy of classes that write output as a stream of bytes. It provides a common set of methods for writing bytes to stream. Subclasses implement and/or extend these methods to write bytes in a particular manner or to a particular destination such as a file on disk or network connection.

Author:

Aaron M. Renn (arenn@urbanophile.com), Tom Tromey

Constructor Summary

Constructors

Constructor and Description
OutputStream()

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the stream.
protected void	finalize() This method (when overriden), will be called when the VM determines that the Object can be garbage collected.
void	flush() This method forces any data that may have been buffered to be written to the underlying output device.
void	write(byte[] b) This method all the writes bytes from the passed array to the output stream.
void	write(byte[] data, int offset, int count) This method writes len bytes from the specified array b starting at index off into the array.
void	write(int b) This method writes a single byte to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStream

public OutputStream()

Method Detail

write

public void write(int b)
           throws IOException

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.

Parameters:

b - 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[] b)
           throws IOException,
                  NullPointerException

This method all the writes bytes from the passed array to the output stream. This method is equivalent to write(b, 0, buf.length) which is exactly how it is implemented in this class.

Parameters:

b - The array of bytes to write

Throws:

IOException - If an error occurs

NullPointerException

write

public void write(byte[] data,
                  int offset,
                  int count)
           throws IOException,
                  NullPointerException,
                  IndexOutOfBoundsException

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.

Parameters:

data - 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

NullPointerException

IndexOutOfBoundsException

flush

public void flush()
           throws IOException

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.

Throws:

IOException - If an error occurs

close

public void close()
           throws IOException

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.

Throws:

IOException - If an error occurs

finalize

protected void finalize()

Description copied from class: Object

This method (when overriden), will be called when the VM determines that the Object can be garbage collected. Any action can be taken by the finalize() method, including making the Object available to other Threads (which would stop the garbage collection of the Object).

The finalize() method of a Class is only called if it overrides finalize() - the finalize() method java.lang.Object is never called by the Eve VM.

Overrides:

finalize in class Object