Added in API level 1

GZIPOutputStream

open class GZIPOutputStream : DeflaterOutputStream
kotlin.Any
   ↳ java.io.OutputStream
   ↳ java.io.FilterOutputStream
   ↳ java.util.zip.DeflaterOutputStream
   ↳ java.util.zip.GZIPOutputStream

This class implements a stream filter for writing compressed data in the GZIP file format.

Summary

Public constructors

Creates a new output stream with the specified buffer size.

GZIPOutputStream(out: OutputStream!, size: Int, syncFlush: Boolean)

Creates a new output stream with the specified buffer size and flush mode.

Creates a new output stream with a default buffer size.

Creates a new output stream with a default buffer size and the specified flush mode.

Public methods
open Unit

Finishes writing compressed data to the output stream without closing the underlying stream.

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

Writes array of bytes to the compressed output stream.

Inherited functions
Properties
CRC32!

CRC-32 of uncompressed data.

Inherited properties

Public constructors

GZIPOutputStream

Added in API level 1
GZIPOutputStream(
    out: OutputStream!,
    size: Int)

Creates a new output stream with the specified buffer size.

The new output stream instance is created as if by invoking the 3-argument constructor GZIPOutputStream(out, size, false). Android-note: Android limits the number of UnbufferedIO operations that can be performed, so consider using buffered inputs with this class. More information can be found in the UnbufferedIO and StrictMode documentation.

Parameters
out OutputStream!: the output stream
size Int: the output buffer size
Exceptions
java.io.IOException If an I/O error has occurred.
java.lang.IllegalArgumentException if size <= 0

GZIPOutputStream

Added in API level 1
GZIPOutputStream(
    out: OutputStream!,
    size: Int,
    syncFlush: Boolean)

Creates a new output stream with the specified buffer size and flush mode.

Parameters
out OutputStream!: the output stream
size Int: the output buffer size
syncFlush Boolean: if true invocation of the inherited java.util.zip.DeflaterOutputStream#flush() method of this instance flushes the compressor with flush mode Deflater#SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream
Exceptions
java.io.IOException If an I/O error has occurred.
java.lang.IllegalArgumentException if size <= 0

GZIPOutputStream

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

Creates a new output stream with a default buffer size.

The new output stream instance is created as if by invoking the 2-argument constructor GZIPOutputStream(out, false).

Parameters
out OutputStream!: the output stream
Exceptions
java.io.IOException If an I/O error has occurred.

GZIPOutputStream

Added in API level 1
GZIPOutputStream(
    out: OutputStream!,
    syncFlush: Boolean)

Creates a new output stream with a default buffer size and the specified flush mode.

Parameters
out OutputStream!: the output stream
syncFlush Boolean: if true invocation of the inherited java.util.zip.DeflaterOutputStream#flush() method of this instance flushes the compressor with flush mode Deflater#SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream
Exceptions
java.io.IOException If an I/O error has occurred.

Public methods

finish

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

Finishes writing compressed data to the output stream without closing the underlying stream. Use this method when applying multiple filters in succession to the same output stream.

Exceptions
java.io.IOException if an I/O error has occurred

write

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

Writes array of bytes to the compressed output stream. This method will block until all the bytes are written.

Parameters
b the data to be written
off Int: the start offset of the data
len Int: the length of the data
buf ByteArray!: the data to be written
Exceptions
java.io.IOException If an I/O error has occurred.

Properties

crc

Added in API level 1
protected var crc: CRC32!

CRC-32 of uncompressed data.