Skip to content

Most visited

Recently visited

navigation
Added in API level 1

ZipInputStream

public class ZipInputStream
extends InflaterInputStream

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


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

From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream

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

From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Constants

CENATT

Added in API level 21
int CENATT

Constant Value: 36 (0x00000024)

CENATX

Added in API level 21
int CENATX

Constant Value: 38 (0x00000026)

CENCOM

Added in API level 21
int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

Added in API level 21
int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

Added in API level 21
int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

Added in API level 21
int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

Added in API level 21
int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

Added in API level 21
int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

Added in API level 21
int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

Added in API level 21
int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

Added in API level 21
int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

Added in API level 21
int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

Added in API level 21
long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

Added in API level 21
int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

Added in API level 21
int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

Added in API level 21
int CENVEM

Constant Value: 4 (0x00000004)

CENVER

Added in API level 21
int CENVER

Constant Value: 6 (0x00000006)

ENDCOM

Added in API level 21
int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

Added in API level 21
int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

Added in API level 21
int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

Added in API level 21
long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

Added in API level 21
int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

Added in API level 21
int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

Added in API level 21
int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

Added in API level 21
int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

Added in API level 21
int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

Added in API level 21
int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

Added in API level 21
long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

Added in API level 21
int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

Added in API level 21
int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

Added in API level 21
int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

Added in API level 21
int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

Added in API level 21
int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

Added in API level 21
int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

Added in API level 21
int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

Added in API level 21
int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

Added in API level 21
long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

Added in API level 21
int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

Added in API level 21
int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

Added in API level 21
int LOCVER

Constant Value: 4 (0x00000004)

Public constructors

ZipInputStream

Added in API level 1
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
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
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
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
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
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
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
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
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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.