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`
static Int	`CENATX`
static Int	`CENCOM`
static Int	`CENCRC`
static Int	`CENDSK`
static Int	`CENEXT`
static Int	`CENFLG`
static Int	`CENHDR`
static Int	`CENHOW`
static Int	`CENLEN`
static Int	`CENNAM`
static Int	`CENOFF`
static Long	`CENSIG`
static Int	`CENSIZ`
static Int	`CENTIM`
static Int	`CENVEM`
static Int	`CENVER`
static Int	`DEFLATED` Compression method for compressed (DEFLATED) entries.
static Int	`ENDCOM`
static Int	`ENDHDR`
static Int	`ENDOFF`
static Long	`ENDSIG`
static Int	`ENDSIZ`
static Int	`ENDSUB`
static Int	`ENDTOT`
static Int	`EXTCRC`
static Int	`EXTHDR`
static Int	`EXTLEN`
static Long	`EXTSIG`
static Int	`EXTSIZ`
static Int	`LOCCRC`
static Int	`LOCEXT`
static Int	`LOCFLG`
static Int	`LOCHDR`
static Int	`LOCHOW`
static Int	`LOCLEN`
static Int	`LOCNAM`
static Long	`LOCSIG`
static Int	`LOCSIZ`
static Int	`LOCTIM`
static Int	`LOCVER`
static Int	`STORED` Compression method for uncompressed (STORED) entries.

Public constructors
`<init>(out: OutputStream!)` Creates a new ZIP output stream.
`<init>(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 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 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.

Constants

CENATT

Added in API level 21

static val CENATT: Int

Value: 36

CENATX

Added in API level 21

static val CENATX: Int

Value: 38

CENCOM

Added in API level 21

static val CENCOM: Int

Value: 32

CENCRC

Added in API level 21

static val CENCRC: Int

Value: 16

CENDSK

Added in API level 21

static val CENDSK: Int

Value: 34

CENEXT

Added in API level 21

static val CENEXT: Int

Value: 30

CENFLG

Added in API level 21

static val CENFLG: Int

Value: 8

CENHDR

Added in API level 21

static val CENHDR: Int

Value: 46

CENHOW

Added in API level 21

static val CENHOW: Int

Value: 10

CENLEN

Added in API level 21

static val CENLEN: Int

Value: 24

CENNAM

Added in API level 21

static val CENNAM: Int

Value: 28

CENOFF

Added in API level 21

static val CENOFF: Int

Value: 42

CENSIG

Added in API level 21

static val CENSIG: Long

Value: 33639248L

CENSIZ

Added in API level 21

static val CENSIZ: Int

Value: 20

CENTIM

Added in API level 21

static val CENTIM: Int

Value: 12

CENVEM

Added in API level 21

static val CENVEM: Int

Value: 4

CENVER

Added in API level 21

static val CENVER: Int

Value: 6

DEFLATED

Added in API level 1

static val DEFLATED: Int

Compression method for compressed (DEFLATED) entries.

Value: 8

ENDCOM

Added in API level 21

static val ENDCOM: Int

Value: 20

ENDHDR

Added in API level 21

static val ENDHDR: Int

Value: 22

ENDOFF

Added in API level 21

static val ENDOFF: Int

Value: 16

ENDSIG

Added in API level 21

static val ENDSIG: Long

Value: 101010256L

ENDSIZ

Added in API level 21

static val ENDSIZ: Int

Value: 12

ENDSUB

Added in API level 21

static val ENDSUB: Int

Value: 8

ENDTOT

Added in API level 21

static val ENDTOT: Int

Value: 10

EXTCRC

Added in API level 21

static val EXTCRC: Int

Value: 4

EXTHDR

Added in API level 21

static val EXTHDR: Int

Value: 16

EXTLEN

Added in API level 21

static val EXTLEN: Int

Value: 12

EXTSIG

Added in API level 21

static val EXTSIG: Long

Value: 134695760L

EXTSIZ

Added in API level 21

static val EXTSIZ: Int

Value: 8

LOCCRC

Added in API level 21

static val LOCCRC: Int

Value: 14

LOCEXT

Added in API level 21

static val LOCEXT: Int

Value: 28

LOCFLG

Added in API level 21

static val LOCFLG: Int

Value: 6

LOCHDR

Added in API level 21

static val LOCHDR: Int

Value: 30

LOCHOW

Added in API level 21

static val LOCHOW: Int

Value: 8

LOCLEN

Added in API level 21

static val LOCLEN: Int

Value: 22

LOCNAM

Added in API level 21

static val LOCNAM: Int

Value: 26

LOCSIG

Added in API level 21

static val LOCSIG: Long

Value: 67324752L

LOCSIZ

Added in API level 21

static val LOCSIZ: Int

Value: 18

LOCTIM

Added in API level 21

static val LOCTIM: Int

Value: 10

LOCVER

Added in API level 21

static val LOCVER: Int

Value: 4

STORED

Added in API level 1

static val STORED: Int

Compression method for uncompressed (STORED) entries.

Value: 0

Public constructors

<init>

Added in API level 1

ZipOutputStream(out: OutputStream!)

Creates a new ZIP output stream.

The UTF-8 charset is used to encode the entry names and comments.

Parameters
`out`	OutputStream!: the actual output stream

<init>

Added in API level 24

ZipOutputStream(
    out: OutputStream!, 
    charset: Charset!)

Creates a new ZIP output stream.

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

Public methods

close

Added in API level 1

open fun close(): Unit

Closes the ZIP output stream as well as the stream being filtered.

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

closeEntry

Added in API level 1

open fun closeEntry(): Unit

Closes the current ZIP entry and positions the stream for writing the next entry.

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

finish

Added in API level 1

open fun finish(): Unit

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

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

putNextEntry

Added in API level 1

open fun putNextEntry(e: ZipEntry!): Unit

Begins writing a new ZIP file entry and positions the stream to the start of the entry data. Closes the current entry if still active. The default compression method will be used if no compression method was specified for the entry, and the current time will be used if the entry has no set modification time.

Parameters
`e`	ZipEntry!: the ZIP entry to be written

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

setComment

Added in API level 1

open fun setComment(comment: String!): Unit

Sets the ZIP file comment.

Parameters
`comment`	String!: the comment string

Exceptions
`java.lang.IllegalArgumentException`	if the length of the specified ZIP file comment is greater than 0xFFFF bytes

setLevel

Added in API level 1

open fun setLevel(level: Int): Unit

Sets the compression level for subsequent entries which are DEFLATED. The default setting is DEFAULT_COMPRESSION.

Parameters
`level`	Int: the compression level (0-9)

Exceptions
`java.lang.IllegalArgumentException`	if the compression level is invalid

setMethod

Added in API level 1

open fun setMethod(method: Int): Unit

Sets the default compression method for subsequent entries. This default will be used whenever the compression method is not specified for an individual ZIP file entry, and is initially set to DEFLATED.

Parameters
`method`	Int: the default compression method

Exceptions
`java.lang.IllegalArgumentException`	if the specified compression method is invalid

write

Added in API level 1

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

Writes an array of bytes to the current ZIP entry data. This method will block until all the bytes are written.

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

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