Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

ZipInputStream

public class ZipInputStream
extends InflaterInputStream

java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.FilterInputStream
       ↳ java.util.zip.InflaterInputStream
         ↳ java.util.zip.ZipInputStream


This class implements an input stream filter for reading 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 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

Inherited fields

Public constructors

ZipInputStream(InputStream in)

Creates a new ZIP input stream.

ZipInputStream(InputStream in, Charset charset)

Creates a new ZIP input stream.

Public methods

int available()

Returns 0 after EOF has reached for the current entry data, otherwise always return 1.

void close()

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

void closeEntry()

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

ZipEntry getNextEntry()

Reads the next ZIP file entry and positions the stream at the beginning of the entry data.

int read(byte[] b, int off, int len)

Reads from the current ZIP entry into an array of bytes.

long skip(long n)

Skips specified number of bytes in the current ZIP entry.

Protected methods

ZipEntry createZipEntry(String name)

Creates a new ZipEntry object for the specified entry name.

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)

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)

Public constructors

ZipInputStream

added in API level 1
public ZipInputStream (InputStream in)

Creates a new ZIP input stream.

The UTF-8 charset is used to decode the entry names.

Parameters
in InputStream: the actual input stream

ZipInputStream

added in API level 24
public ZipInputStream (InputStream in, 
                Charset charset)

Creates a new ZIP input stream.

Parameters
in InputStream: the actual input stream

charset Charset: The charset to be used to decode the ZIP entry name (ignored if the language encoding bit of the ZIP entry's general purpose bit flag is set).

Public methods

available

added in API level 1
public int available ()

Returns 0 after EOF has reached for the current entry data, otherwise always return 1.

Programs should not count on this method to return the actual number of bytes that could be read without blocking.

Returns
int 1 before EOF and 0 after EOF has reached for current entry.

Throws
IOException if an I/O error occurs.

close

added in API level 1
public void close ()

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

Throws
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 reading the next entry.

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

getNextEntry

added in API level 1
public ZipEntry getNextEntry ()

Reads the next ZIP file entry and positions the stream at the beginning of the entry data.

Returns
ZipEntry the next ZIP file entry, or null if there are no more entries

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

read

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

Reads from the current ZIP entry into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters
b byte: the buffer into which the data is read

off int: the start offset in the destination array b

len int: the maximum number of bytes read

Returns
int the actual number of bytes read, or -1 if the end of the entry is reached

Throws
NullPointerException if b is null.
IndexOutOfBoundsException if off is negative, len is negative, or len is greater than b.length - off
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred

skip

added in API level 1
public long skip (long n)

Skips specified number of bytes in the current ZIP entry.

Parameters
n long: the number of bytes to skip

Returns
long the actual number of bytes skipped

Throws
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred
IllegalArgumentException if n < 0

Protected methods

createZipEntry

added in API level 1
protected ZipEntry createZipEntry (String name)

Creates a new ZipEntry object for the specified entry name.

Parameters
name String: the ZIP file entry name

Returns
ZipEntry the ZipEntry just created