| java.lang.Object java.io.OutputStream java.io.FilterOutputStream
All known Subclasses: java.util.zip.CheckedOutputStream, java.io.BufferedOutputStream, java.util.zip.DeflaterOutputStream, java.security.DigestOutputStream,
FilterOutputStream | public class FilterOutputStream extends OutputStream (Code) | | This class is the superclass of all classes that filter output
streams. These streams sit on top of an already existing output
stream (the underlying output stream) which it uses as its
basic sink of data, but possibly transforming the data along the
way or providing additional functionality.
The class FilterOutputStream itself simply overrides
all methods of OutputStream with versions that pass
all requests to the underlying output stream. Subclasses of
FilterOutputStream may further override some of these
methods as well as provide additional methods and fields.
author: Jonathan Payne version: 1.28, 02/02/00 since: JDK1.0 |
Field Summary | |
protected OutputStream | out The underlying output stream to be filtered. |
Constructor Summary | |
public | FilterOutputStream(OutputStream out) Creates an output stream filter built on top of the specified
underlying output stream. |
Method Summary | |
public void | close() Closes this output stream and releases any system resources
associated with the stream. | public void | flush() Flushes this output stream and forces any buffered output bytes
to be written out to the stream. | public void | write(int b) Writes the specified byte to this output stream. | public void | write(byte b) Writes b.length bytes to this output stream. | public void | write(byte b, int off, int len) Writes len bytes from the specified
byte array starting at offset off to
this output stream. |
FilterOutputStream | public FilterOutputStream(OutputStream out)(Code) | | Creates an output stream filter built on top of the specified
underlying output stream.
Parameters: out - the underlying output stream to be assigned to the field this.out for later use, or null if this instance is to be created without an underlying stream. |
flush | public void flush() throws IOException(Code) | | Flushes this output stream and forces any buffered output bytes
to be written out to the stream.
The flush method of FilterOutputStream
calls the flush method of its underlying output stream.
exception: IOException - if an I/O error occurs. See Also: java.io.FilterOutputStream.out |
write | public void write(int b) throws IOException(Code) | | Writes the specified byte to this output stream.
The write method of FilterOutputStream
calls the write method of its underlying output stream,
that is, it performs out.write(b).
Implements the abstract write method of OutputStream.
Parameters: b - the byte . exception: IOException - if an I/O error occurs. |
write | public void write(byte b) throws IOException(Code) | | Writes b.length bytes to this output stream.
The write method of FilterOutputStream
calls its write method of three arguments with the
arguments b , 0 , and
b.length .
Note that this method does not call the one-argument
write method of its underlying stream with the single
argument b .
Parameters: b - the data to be written. exception: IOException - if an I/O error occurs. See Also: java.io.FilterOutputStream.write(byte[]intint) |
write | public void write(byte b, int off, int len) throws IOException(Code) | | Writes len bytes from the specified
byte array starting at offset off to
this output stream.
The write method of FilterOutputStream
calls the write method of one argument on each
byte to output.
Note that this method does not call the write method
of its underlying input stream with the same arguments. Subclasses
of FilterOutputStream should provide a more efficient
implementation of this method.
Parameters: b - the data. Parameters: off - the start offset in the data. Parameters: len - the number of bytes to write. exception: IOException - if an I/O error occurs. See Also: java.io.FilterOutputStream.write(int) |
|
|