Added in API level 1

ZipOutputStream

open class ZipOutputStream : DeflaterOutputStream

kotlin.Any
↳	java.io.OutputStream
	↳	java.io.FilterOutputStream
		↳	java.util.zip.DeflaterOutputStream
			↳	java.util.zip.ZipOutputStream

Known Direct Subclasses

JarOutputStream

The JarOutputStream class is used to write the contents of a JAR file to any output stream.

This class implements an output stream filter for writing files in the ZIP file format. Includes support for both compressed and uncompressed entries.

Summary

Constants
static Int	`CENATT` Central directory (CEN) header internal file attributes field offset.
static Int	`CENATX` Central directory (CEN) header external file attributes field offset.
static Int	`CENCOM` Central directory (CEN) header comment length field offset.
static Int	`CENCRC` Central directory (CEN) header uncompressed file crc-32 value field offset.
static Int	`CENDSK` Central directory (CEN) header disk number start field offset.
static Int	`CENEXT` Central directory (CEN) header extra field length field offset.
static Int	`CENFLG` Central directory (CEN) header encrypt, decrypt flags field offset.
static Int	`CENHDR` Central directory (CEN) header size in bytes (including signature).
static Int	`CENHOW` Central directory (CEN) header compression method field offset.
static Int	`CENLEN` Central directory (CEN) header uncompressed size field offset.
static Int	`CENNAM` Central directory (CEN) header filename length field offset.
static Int	`CENOFF` Central directory (CEN) header LOC header offset field offset.
static Long	`CENSIG` Central directory (CEN) header signature.
static Int	`CENSIZ` Central directory (CEN) header compressed size field offset.
static Int	`CENTIM` Central directory (CEN) header modification time field offset.
static Int	`CENVEM` Central directory (CEN) header version made by field offset.
static Int	`CENVER` Central directory (CEN) header version needed to extract field offset.
static Int	`DEFLATED` Compression method for compressed (DEFLATED) entries.
static Int	`ENDCOM` End of central directory (END) header zip file comment length field offset.
static Int	`ENDHDR` End of central directory (END) header size in bytes (including signature).
static Int	`ENDOFF` End of central directory (END) header offset for the first CEN header field offset.
static Long	`ENDSIG` End of central directory (END) header signature.
static Int	`ENDSIZ` End of central directory (END) header central directory size in bytes field offset.
static Int	`ENDSUB` End of central directory (END) header number of entries on this disk field offset.
static Int	`ENDTOT` End of central directory (END) header total number of entries field offset.
static Int	`EXTCRC` Extra local (EXT) header uncompressed file crc-32 value field offset.
static Int	`EXTHDR` Extra local (EXT) header size in bytes (including signature).
static Int	`EXTLEN` Extra local (EXT) header uncompressed size field offset.
static Long	`EXTSIG` Extra local (EXT) header signature.
static Int	`EXTSIZ` Extra local (EXT) header compressed size field offset.
static Int	`LOCCRC` Local file (LOC) header uncompressed file crc-32 value field offset.
static Int	`LOCEXT` Local file (LOC) header extra field length field offset.
static Int	`LOCFLG` Local file (LOC) header general purpose bit flag field offset.
static Int	`LOCHDR` Local file (LOC) header size in bytes (including signature).
static Int	`LOCHOW` Local file (LOC) header compression method field offset.
static Int	`LOCLEN` Local file (LOC) header uncompressed size field offset.
static Int	`LOCNAM` Local file (LOC) header filename length field offset.
static Long	`LOCSIG` Local file (LOC) header signature.
static Int	`LOCSIZ` Local file (LOC) header compressed size field offset.
static Int	`LOCTIM` Local file (LOC) header modification time field offset.
static Int	`LOCVER` Local file (LOC) header version needed to extract field offset.
static Int	`STORED` Compression method for uncompressed (STORED) entries.

Public constructors
`ZipOutputStream(out: OutputStream!)` Creates a new ZIP output stream.
`ZipOutputStream(out: OutputStream!, charset: Charset!)` Creates a new ZIP output stream.

Public methods
open Unit	`close()` Closes the ZIP output stream as well as the stream being filtered.
open Unit	`closeEntry()` Closes the current ZIP entry and positions the stream for writing the next entry.
open Unit	`finish()` Finishes writing the contents of the ZIP output stream without closing the underlying stream.
open Unit	`putNextEntry(e: ZipEntry!)` Begins writing a new ZIP file entry and positions the stream to the start of the entry data.
open Unit	`setComment(comment: String!)` Sets the ZIP file comment.
open Unit	`setLevel(level: Int)` Sets the compression level for subsequent entries which are DEFLATED.
open Unit	`setMethod(method: Int)` Sets the default compression method for subsequent entries.
open Unit	`write(b: ByteArray!, off: Int, len: Int)` Writes an array of bytes to the current ZIP entry data.

Inherited functions

From class DeflaterOutputStream

Unit

deflate()

Writes next block of compressed data to the output stream.

Unit

flush()

Flushes the compressed output stream. If syncFlush is true when this compressed output stream is constructed, this method first flushes the underlying compressor with the flush mode Deflater#SYNC_FLUSH to force all pending data to be flushed out to the output stream and then flushes the output stream. Otherwise this method only flushes the output stream without flushing the compressor.

Unit

write(b: Int)

Writes a byte to the compressed output stream. This method will block until the byte can be written.

From class OutputStream

OutputStream!

nullOutputStream()

Returns a new OutputStream which discards all bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.

While the stream is open, the write(int), write(byte[]), and write(byte[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException.

The flush() method does nothing.

From class FilterOutputStream

Unit

write(b: ByteArray!)

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.

Inherited properties

From class DeflaterOutputStream

ByteArray!

buf

Output buffer for writing compressed data.

Deflater!

def

Compressor for this stream.

From class FilterOutputStream

OutputStream!

out

The underlying output stream to be filtered.

Parameters
`out`	OutputStream!: the actual output stream
`charset`	Charset!: the charset to be used to encode the entry names and comments

Exceptions
`java.lang.Exception`	if this resource cannot be closed
`java.io.IOException`	if an I/O error has occurred
`java.util.zip.ZipException`	if a ZIP file error has occurred

Exceptions
`java.util.zip.ZipException`	if a ZIP format error has occurred
`java.io.IOException`	if an I/O error has occurred

Exceptions
`java.io.IOException`	if an I/O exception has occurred
`java.util.zip.ZipException`	if a ZIP file error has occurred

Parameters
`b`	ByteArray!: the data to be written
`off`	Int: the start offset in the data
`len`	Int: the number of bytes that are written

ZipOutputStream

Summary

Constants

CENATT

CENATX

CENCOM

CENCRC

CENDSK

CENEXT

CENFLG

CENHDR

CENHOW

CENLEN

CENNAM

CENOFF

CENSIG

CENSIZ

CENTIM

CENVEM

CENVER

DEFLATED

ENDCOM

ENDHDR

ENDOFF

ENDSIG

ENDSIZ

ENDSUB

ENDTOT

EXTCRC

EXTHDR

EXTLEN

EXTSIG

EXTSIZ

LOCCRC

LOCEXT

LOCFLG

LOCHDR

LOCHOW

LOCLEN

LOCNAM

LOCSIG

LOCSIZ

LOCTIM

LOCVER

STORED

Public constructors

ZipOutputStream

ZipOutputStream

Public methods

close

closeEntry

finish

putNextEntry

setComment

setLevel

setMethod

write