public class

FilterOutputStream

extends OutputStream
java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Wraps an existing OutputStream and performs some transformation on the output data while it is being written. Transformations can be anything from a simple byte-wise filtering output data to an on-the-fly compression or decompression of the underlying stream. Output streams that wrap another output stream and provide some additional functionality on top of it usually inherit from this class.

See Also

Summary

Fields
protected OutputStream out The target output stream for this filter stream.
Public Constructors
FilterOutputStream(OutputStream out)
Constructs a new FilterOutputStream with out as its target stream.
Public Methods
void close()
Closes this stream.
void flush()
Ensures that all pending data is sent out to the target stream.
void write(byte[] buffer)
Writes the entire contents of the byte array buffer to this stream.
void write(int oneByte)
Writes one byte to the target stream.
void write(byte[] buffer, int offset, int count)
Writes count bytes from the byte array buffer starting at offset to the target stream.
[Expand]
Inherited Methods
From class java.io.OutputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable

Fields

protected OutputStream out

Since: API Level 1

The target output stream for this filter stream.

Public Constructors

public FilterOutputStream (OutputStream out)

Since: API Level 1

Constructs a new FilterOutputStream with out as its target stream.

Parameters
out the target stream that this stream writes to.

Public Methods

public void close ()

Since: API Level 1

Closes this stream. This implementation closes the target stream.

Throws
IOException if an error occurs attempting to close this stream.

public void flush ()

Since: API Level 1

Ensures that all pending data is sent out to the target stream. This implementation flushes the target stream.

Throws
IOException if an error occurs attempting to flush this stream.

public void write (byte[] buffer)

Since: API Level 1

Writes the entire contents of the byte array buffer to this stream. This implementation writes the buffer to the target stream.

Parameters
buffer the buffer to be written.
Throws
IOException if an I/O error occurs while writing to this stream.

public void write (int oneByte)

Since: API Level 1

Writes one byte to the target stream. Only the low order byte of the integer oneByte is written.

Parameters
oneByte the byte to be written.
Throws
IOException if an I/O error occurs while writing to this stream.

public void write (byte[] buffer, int offset, int count)

Since: API Level 1

Writes count bytes from the byte array buffer starting at offset to the target stream.

Parameters
buffer the buffer to write.
offset the index of the first byte in buffer to write.
count the number of bytes in buffer to write.
Throws
IndexOutOfBoundsException if offset < 0 or count < 0, or if offset + count is bigger than the length of buffer.
IOException if an I/O error occurs while writing to this stream.