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.11, 08/13/95
Author:
Jonathan Payne

Variable Index

 o out
The actual output stream.

Constructor Index

 o FilterOutputStream(OutputStream)
Creates an output stream filter.

Method Index

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

Variables

 o out
  protected OutputStream out
The actual output stream.

Constructors

 o FilterOutputStream
  public FilterOutputStream(OutputStream out)
Creates an output stream filter.
Parameters:
out - the output stream

Methods

 o write
  public void write(int b) throws IOException
Writes a byte. Will block until the byte is actually written.
Parameters:
b - the byte
Throws: IOException
If an I/O error has occurred.
Overrides:
write in class OutputStream

 o write

  public void write(byte b[]) throws IOException
Writes an array of bytes. Will block until the bytes are actually written.
Parameters:
b - the data to be written
Throws: IOException
If an I/O error has occurred.
Overrides:
write in class OutputStream

 o write

  public void write(byte b[],
                    int off,
                    int len) throws IOException
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
If an I/O error has occurred.
Overrides:
write in class OutputStream

 o flush

  public void flush() throws IOException
Flushes the stream. This will write any buffered output bytes.
Throws: IOException
If an I/O error has occurred.
Overrides:
flush in class OutputStream

 o close

  public void close() throws IOException
Closes the stream. This method must be called to release any resources associated with the stream.
Throws: IOException
If an I/O error has occurred.
Overrides:
close in class OutputStream


All Packages    This Package    Previous    Next