lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

ZipOutputStream

public class ZipOutputStream
extends DeflaterOutputStream

java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
       ↳ java.util.zip.DeflaterOutputStream
         ↳ java.util.zip.ZipOutputStream


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

int CENATT

int CENATX

int CENCOM

int CENCRC

int CENDSK

int CENEXT

int CENFLG

int CENHDR

int CENHOW

int CENLEN

int CENNAM

int CENOFF

long CENSIG

int CENSIZ

int CENTIM

int CENVEM

int CENVER

int DEFLATED

Compression method for compressed (DEFLATED) entries.

int ENDCOM

int ENDHDR

int ENDOFF

long ENDSIG

int ENDSIZ

int ENDSUB

int ENDTOT

int EXTCRC

int EXTHDR

int EXTLEN

long EXTSIG

int EXTSIZ

int LOCCRC

int LOCEXT

int LOCFLG

int LOCHDR

int LOCHOW

int LOCLEN

int LOCNAM

long LOCSIG

int LOCSIZ

int LOCTIM

int LOCVER

int STORED

Compression method for uncompressed (STORED) entries.

Inherited fields

Public constructors

ZipOutputStream(OutputStream out)

Creates a new ZIP output stream.

ZipOutputStream(OutputStream out, Charset charset)

Creates a new ZIP output stream.

Public methods

void close()

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

void closeEntry()

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

void finish()

Finishes writing the contents of the ZIP output stream without closing the underlying stream.

void putNextEntry(ZipEntry e)

Begins writing a new ZIP file entry and positions the stream to the start of the entry data.

void setComment(String comment)

Sets the ZIP file comment.

void setLevel(int level)

Sets the compression level for subsequent entries which are DEFLATED.

void setMethod(int method)

Sets the default compression method for subsequent entries.

void write(byte[] b, int off, int len)

Writes an array of bytes to the current ZIP entry data.

Inherited methods

Constants

CENATT

added in API level 21
public static final int CENATT

Constant Value: 36 (0x00000024)

CENATX

added in API level 21
public static final int CENATX

Constant Value: 38 (0x00000026)

CENCOM

added in API level 21
public static final int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

added in API level 21
public static final int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

added in API level 21
public static final int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

added in API level 21
public static final int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

added in API level 21
public static final int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

added in API level 21
public static final int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

added in API level 21
public static final int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

added in API level 21
public static final int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

added in API level 21
public static final int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

added in API level 21
public static final int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

added in API level 21
public static final long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

added in API level 21
public static final int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

added in API level 21
public static final int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

added in API level 21
public static final int CENVEM

Constant Value: 4 (0x00000004)

CENVER

added in API level 21
public static final int CENVER

Constant Value: 6 (0x00000006)

DEFLATED

added in API level 1
public static final int DEFLATED

Compression method for compressed (DEFLATED) entries.

Constant Value: 8 (0x00000008)

ENDCOM

added in API level 21
public static final int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

added in API level 21
public static final int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

added in API level 21
public static final int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

added in API level 21
public static final long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

added in API level 21
public static final int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

added in API level 21
public static final int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

added in API level 21
public static final int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

added in API level 21
public static final int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

added in API level 21
public static final int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

added in API level 21
public static final int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

added in API level 21
public static final long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

added in API level 21
public static final int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

added in API level 21
public static final int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

added in API level 21
public static final int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

added in API level 21
public static final int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

added in API level 21
public static final int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

added in API level 21
public static final int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

added in API level 21
public static final int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

added in API level 21
public static final int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

added in API level 21
public static final long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

added in API level 21
public static final int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

added in API level 21
public static final int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

added in API level 21
public static final int LOCVER

Constant Value: 4 (0x00000004)

STORED

added in API level 1
public static final int STORED

Compression method for uncompressed (STORED) entries.

Constant Value: 0 (0x00000000)

Public constructors

ZipOutputStream

added in API level 1
public ZipOutputStream (OutputStream out)

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

ZipOutputStream

added in API level 24
public ZipOutputStream (OutputStream out, 
                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
public void close ()

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

Throws
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred

closeEntry

added in API level 1
public void closeEntry ()

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

Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred

finish

added in API level 1
public void finish ()

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.

Throws
ZipException if a ZIP file error has occurred
IOException if an I/O exception has occurred

putNextEntry

added in API level 1
public void putNextEntry (ZipEntry e)

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

Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred

setComment

added in API level 1
public void setComment (String comment)

Sets the ZIP file comment.

Parameters
comment String: the comment string

Throws
IllegalArgumentException if the length of the specified ZIP file comment is greater than 0xFFFF bytes

setLevel

added in API level 1
public void setLevel (int level)

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

Parameters
level int: the compression level (0-9)

Throws
IllegalArgumentException if the compression level is invalid

setMethod

added in API level 1
public void setMethod (int method)

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

Throws
IllegalArgumentException if the specified compression method is invalid

write

added in API level 1
public void write (byte[] b, 
                int off, 
                int len)

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

Parameters
b byte: the data to be written

off int: the start offset in the data

len int: the number of bytes that are written

Throws
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred