java::io::OutputStream Class Reference

Inheritance diagram for java::io::OutputStream:

Inheritance graph
java::io::BufferedOutputStreamjava::io::ByteArrayOutputStreamjava::io::FileOutputStreamjava::io::FilterOutputStreamjava::io::PrintStreamjava::io::RandomAccessFilejava::lang::Interfacejava::lang::Objectjava::io::DataOutputStream
[legend]
Collaboration diagram for java::io::OutputStream:

Collaboration graph
java::lang::Interfacejava::lang::Object
[legend]

List of all members.


Detailed Description

The interface of all classes representing an output stream of bytes.

An output stream accepts output bytes and sends them to some sink.

Applications that need to define a subclass of OutputStream must always provide at least a method that writes one byte of output.

Author:
Arthur van Hoff
Version:
1.23, 02/02/00
Since:
JDK1.0

Public Member Functions

virtual void write (jint b)=0
 Writes the specified byte to this output stream.
virtual void write (const Array< jbyte > &b, jint ofs=0, jint len=-1)=0
 Writes len bytes from the specified byte array starting at offset off to this output stream.
virtual void flush ()
 Flushes this output stream and forces any buffered output bytes to be written out.
virtual void close ()
 Closes this output stream and releases any system resources associated with this stream.

Member Function Documentation

virtual void java::io::OutputStream::write ( jint  b  )  [pure virtual]

Writes the specified byte to this output stream.

The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Subclasses of OutputStream must provide an implementation for this method.

Parameters:
b the byte.
Exceptions:
IOException if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

Implemented in java::io::BufferedOutputStream, java::io::ByteArrayOutputStream, java::io::DataOutputStream, java::io::FileOutputStream, java::io::FilterOutputStream, java::io::PrintStream, and java::io::RandomAccessFile.

virtual void java::io::OutputStream::write ( const Array< jbyte > &  b,
jint  ofs = 0,
jint  len = -1 
) [pure virtual]

Writes len bytes from the specified byte array starting at offset off to this output stream.

The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters:
b the data.
off the start offset in the data.
len the number of bytes to write.
Exceptions:
IOException if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

Implemented in java::io::BufferedOutputStream, java::io::ByteArrayOutputStream, java::io::DataOutputStream, java::io::FileOutputStream, java::io::FilterOutputStream, java::io::PrintStream, and java::io::RandomAccessFile.

virtual void java::io::OutputStream::flush (  )  [virtual]

Flushes this output stream and forces any buffered output bytes to be written out.

The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

The flush method of OutputStream does nothing.

Exceptions:
IOException if an I/O error occurs.

Reimplemented in java::io::BufferedOutputStream, java::io::FileOutputStream, java::io::FilterOutputStream, java::io::PrintStream, and java::io::RandomAccessFile.

virtual void java::io::OutputStream::close (  )  [virtual]

Closes this output stream and releases any system resources associated with this stream.

The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

The close method of OutputStream does nothing.

Exceptions:
IOException if an I/O error occurs.

Reimplemented in java::io::BufferedOutputStream, java::io::ByteArrayOutputStream, java::io::FileOutputStream, java::io::FilterOutputStream, java::io::PrintStream, and java::io::RandomAccessFile.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:32 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3