Class java.io.FilterOutputStream

All Packages    This Package    Previous    Next

Class java.io.FilterOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream

public class FilterOutputStream
extends OutputStream

Abstract class representing a filtered output stream of bytes. This class is the basis for enhancing output stream functionality. It allows multiple output stream filters to be chained together, each providing additional functionality.

Version:: 1.7, 31 Jan 1995
Author:: Jonathan Payne

out: The actual output stream.

FilterOutputStream(OutputStream): Create an output stream filter.

close(): Closes the stream.
flush(): Flushes the stream.
write(int): Writes a byte.
write(byte[]): Writes an array of bytes.
write(byte[], int, int): Writes a sub array of bytes.

out

  protected OutputStream out

The actual output stream.

FilterOutputStream

  public FilterOutputStream(OutputStream out)

Create an output stream filter.

Parameters:: out - the output stream

write

  public void write(int b)

Writes a byte. Will block until the byte is actually written.

Parameters:: b - the byte
Throws: IOException: i/o error occurred
Overrides:: write in class OutputStream

write

  public void write(byte b[])

Writes an array of bytes. Will block until the bytes are actually written.

Parameters:: b - the data to be written
Throws: IOException: i/o error occurred
Overrides:: write in class OutputStream

write

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

Writes a sub array of bytes. To be efficient it should be overridden in a subclass.

Parameters:: b - the data to be written; off - the start offset in the data; len - the number of bytes that are written
Throws: IOException: i/o error occurred
Overrides:: write in class OutputStream

flush

  public void flush()

Flushes the stream. This will write any buffered output bytes.

Throws: IOException: i/o error occurred
Overrides:: flush in class OutputStream

close

  public void close()

Closes the stream. This method must be called to release any resources associated with the stream.

Throws: IOException: i/o error occurred
Overrides:: close in class OutputStream

All Packages    This Package    Previous    Next