Added in API level 1

FilterOutputStream

open class FilterOutputStream : OutputStream
kotlin.Any
   ↳ java.io.OutputStream
   ↳ java.io.FilterOutputStream

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.

Summary

Public constructors

Creates an output stream filter built on top of the specified underlying output stream.

Public methods
open Unit

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

open Unit

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

open Unit
write(b: Int)

Writes the specified byte to this output stream.

open Unit

Writes b.length bytes to this output stream.

open Unit
write(b: ByteArray!, off: Int, len: Int)

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

Inherited functions
Properties
OutputStream!

The underlying output stream to be filtered.

Public constructors

FilterOutputStream

Added in API level 1
FilterOutputStream(out: OutputStream!)

Creates an output stream filter built on top of the specified underlying output stream.

Parameters
out OutputStream!: 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.

Public methods

close

Added in API level 1
open fun close(): Unit

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

When not already closed, the close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.

Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException if an I/O error occurs.
java.io.IOException if an I/O error occurs.

flush

Added in API level 1
open fun flush(): Unit

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.

Exceptions
java.io.IOException if an I/O error occurs.
java.io.IOException if an I/O error occurs.

write

Added in API level 1
open fun write(b: Int): Unit

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 Int: the byte.
Exceptions
java.io.IOException if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
java.io.IOException if an I/O error occurs.

write

Added in API level 1
open fun write(b: ByteArray!): Unit

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 output stream with the single argument b.

Parameters
b ByteArray!: the data to be written.
Exceptions
java.io.IOException if an I/O error occurs.
java.io.IOException if an I/O error occurs.

write

Added in API level 1
open fun write(
    b: ByteArray!,
    off: Int,
    len: Int
): Unit

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 output stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method.

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

Properties

out

Added in API level 1
protected var out: OutputStream!

The underlying output stream to be filtered.