Added in API level 1

ZipFile

open class ZipFile : Closeable
kotlin.Any
   ↳ java.util.zip.ZipFile

This class is used to read entries from a zip file.

Unless otherwise noted, passing a null argument to a constructor or method in this class will cause a NullPointerException to be thrown.

Summary

Constants
static Int

Central directory (CEN) header internal file attributes field offset.

static Int

Central directory (CEN) header external file attributes field offset.

static Int

Central directory (CEN) header comment length field offset.

static Int

Central directory (CEN) header uncompressed file crc-32 value field offset.

static Int

Central directory (CEN) header disk number start field offset.

static Int

Central directory (CEN) header extra field length field offset.

static Int

Central directory (CEN) header encrypt, decrypt flags field offset.

static Int

Central directory (CEN) header size in bytes (including signature).

static Int

Central directory (CEN) header compression method field offset.

static Int

Central directory (CEN) header uncompressed size field offset.

static Int

Central directory (CEN) header filename length field offset.

static Int

Central directory (CEN) header LOC header offset field offset.

static Long

Central directory (CEN) header signature.

static Int

Central directory (CEN) header compressed size field offset.

static Int

Central directory (CEN) header modification time field offset.

static Int

Central directory (CEN) header version made by field offset.

static Int

Central directory (CEN) header version needed to extract field offset.

static Int

End of central directory (END) header zip file comment length field offset.

static Int

End of central directory (END) header size in bytes (including signature).

static Int

End of central directory (END) header offset for the first CEN header field offset.

static Long

End of central directory (END) header signature.

static Int

End of central directory (END) header central directory size in bytes field offset.

static Int

End of central directory (END) header number of entries on this disk field offset.

static Int

End of central directory (END) header total number of entries field offset.

static Int

Extra local (EXT) header uncompressed file crc-32 value field offset.

static Int

Extra local (EXT) header size in bytes (including signature).

static Int

Extra local (EXT) header uncompressed size field offset.

static Long

Extra local (EXT) header signature.

static Int

Extra local (EXT) header compressed size field offset.

static Int

Local file (LOC) header uncompressed file crc-32 value field offset.

static Int

Local file (LOC) header extra field length field offset.

static Int

Local file (LOC) header general purpose bit flag field offset.

static Int

Local file (LOC) header size in bytes (including signature).

static Int

Local file (LOC) header compression method field offset.

static Int

Local file (LOC) header uncompressed size field offset.

static Int

Local file (LOC) header filename length field offset.

static Long

Local file (LOC) header signature.

static Int

Local file (LOC) header compressed size field offset.

static Int

Local file (LOC) header modification time field offset.

static Int

Local file (LOC) header version needed to extract field offset.

static Int

Mode flag to open a zip file and mark it for deletion.

static Int

Mode flag to open a zip file for reading.

Public constructors
ZipFile(name: String!)

Opens a zip file for reading.

ZipFile(file: File!, mode: Int)

Opens a new ZipFile to read from the specified File object in the specified mode.

ZipFile(file: File!)

Opens a ZIP file for reading given the specified File object.

ZipFile(file: File!, mode: Int, charset: Charset!)

Opens a new ZipFile to read from the specified File object in the specified mode.

ZipFile(name: String!, charset: Charset!)

Opens a zip file for reading.

ZipFile(file: File!, charset: Charset!)

Opens a ZIP file for reading given the specified File object.

Public methods
open Unit

Closes the ZIP file.

open Enumeration<out ZipEntry!>!

Returns an enumeration of the ZIP file entries.

open String!

Returns the zip file comment, or null if none.

open ZipEntry!
getEntry(name: String!)

Returns the zip file entry for the specified name, or null if not found.

open InputStream!

Returns an input stream for reading the contents of the specified zip file entry.

open String!

Returns the path name of the ZIP file.

open Int

Returns the number of entries in the ZIP file.

open Stream<out ZipEntry!>!

Returns an ordered Stream over the ZIP file entries.

Constants

CENATT

Added in API level 21
static val CENATT: Int

Central directory (CEN) header internal file attributes field offset.

Value: 36

CENATX

Added in API level 21
static val CENATX: Int

Central directory (CEN) header external file attributes field offset.

Value: 38

CENCOM

Added in API level 21
static val CENCOM: Int

Central directory (CEN) header comment length field offset.

Value: 32

CENCRC

Added in API level 21
static val CENCRC: Int

Central directory (CEN) header uncompressed file crc-32 value field offset.

Value: 16

CENDSK

Added in API level 21
static val CENDSK: Int

Central directory (CEN) header disk number start field offset.

Value: 34

CENEXT

Added in API level 21
static val CENEXT: Int

Central directory (CEN) header extra field length field offset.

Value: 30

CENFLG

Added in API level 21
static val CENFLG: Int

Central directory (CEN) header encrypt, decrypt flags field offset.

Value: 8

CENHDR

Added in API level 21
static val CENHDR: Int

Central directory (CEN) header size in bytes (including signature).

Value: 46

CENHOW

Added in API level 21
static val CENHOW: Int

Central directory (CEN) header compression method field offset.

Value: 10

CENLEN

Added in API level 21
static val CENLEN: Int

Central directory (CEN) header uncompressed size field offset.

Value: 24

CENNAM

Added in API level 21
static val CENNAM: Int

Central directory (CEN) header filename length field offset.

Value: 28

CENOFF

Added in API level 21
static val CENOFF: Int

Central directory (CEN) header LOC header offset field offset.

Value: 42

CENSIG

Added in API level 21
static val CENSIG: Long

Central directory (CEN) header signature.

Value: 33639248L

CENSIZ

Added in API level 21
static val CENSIZ: Int

Central directory (CEN) header compressed size field offset.

Value: 20

CENTIM

Added in API level 21
static val CENTIM: Int

Central directory (CEN) header modification time field offset.

Value: 12

CENVEM

Added in API level 21
static val CENVEM: Int

Central directory (CEN) header version made by field offset.

Value: 4

CENVER

Added in API level 21
static val CENVER: Int

Central directory (CEN) header version needed to extract field offset.

Value: 6

ENDCOM

Added in API level 21
static val ENDCOM: Int

End of central directory (END) header zip file comment length field offset.

Value: 20

ENDHDR

Added in API level 21
static val ENDHDR: Int

End of central directory (END) header size in bytes (including signature).

Value: 22

ENDOFF

Added in API level 21
static val ENDOFF: Int

End of central directory (END) header offset for the first CEN header field offset.

Value: 16

ENDSIG

Added in API level 21
static val ENDSIG: Long

End of central directory (END) header signature.

Value: 101010256L

ENDSIZ

Added in API level 21
static val ENDSIZ: Int

End of central directory (END) header central directory size in bytes field offset.

Value: 12

ENDSUB

Added in API level 21
static val ENDSUB: Int

End of central directory (END) header number of entries on this disk field offset.

Value: 8

ENDTOT

Added in API level 21
static val ENDTOT: Int

End of central directory (END) header total number of entries field offset.

Value: 10

EXTCRC

Added in API level 21
static val EXTCRC: Int

Extra local (EXT) header uncompressed file crc-32 value field offset.

Value: 4

EXTHDR

Added in API level 21
static val EXTHDR: Int

Extra local (EXT) header size in bytes (including signature).

Value: 16

EXTLEN

Added in API level 21
static val EXTLEN: Int

Extra local (EXT) header uncompressed size field offset.

Value: 12

EXTSIG

Added in API level 21
static val EXTSIG: Long

Extra local (EXT) header signature.

Value: 134695760L

EXTSIZ

Added in API level 21
static val EXTSIZ: Int

Extra local (EXT) header compressed size field offset.

Value: 8

LOCCRC

Added in API level 21
static val LOCCRC: Int

Local file (LOC) header uncompressed file crc-32 value field offset.

Value: 14

LOCEXT

Added in API level 21
static val LOCEXT: Int

Local file (LOC) header extra field length field offset.

Value: 28

LOCFLG

Added in API level 21
static val LOCFLG: Int

Local file (LOC) header general purpose bit flag field offset.

Value: 6

LOCHDR

Added in API level 21
static val LOCHDR: Int

Local file (LOC) header size in bytes (including signature).

Value: 30

LOCHOW

Added in API level 21
static val LOCHOW: Int

Local file (LOC) header compression method field offset.

Value: 8

LOCLEN

Added in API level 21
static val LOCLEN: Int

Local file (LOC) header uncompressed size field offset.

Value: 22

LOCNAM

Added in API level 21
static val LOCNAM: Int

Local file (LOC) header filename length field offset.

Value: 26

LOCSIG

Added in API level 21
static val LOCSIG: Long

Local file (LOC) header signature.

Value: 67324752L

LOCSIZ

Added in API level 21
static val LOCSIZ: Int

Local file (LOC) header compressed size field offset.

Value: 18

LOCTIM

Added in API level 21
static val LOCTIM: Int

Local file (LOC) header modification time field offset.

Value: 10

LOCVER

Added in API level 21
static val LOCVER: Int

Local file (LOC) header version needed to extract field offset.

Value: 4

OPEN_DELETE

Added in API level 1
static val OPEN_DELETE: Int

Mode flag to open a zip file and mark it for deletion. The file will be deleted some time between the moment that it is opened and the moment that it is closed, but its contents will remain accessible via the ZipFile object until either the close method is invoked or the virtual machine exits.

Value: 4

OPEN_READ

Added in API level 1
static val OPEN_READ: Int

Mode flag to open a zip file for reading.

Value: 1

Public constructors

ZipFile

Added in API level 1
ZipFile(name: String!)

Opens a zip file for reading.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

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

If the app targets Android U or above, zip file entry names containing ".." or starting with "/" passed here will throw a ZipException. For more details, see dalvik.system.ZipPathValidator.

Parameters
name String!: the name of the zip file
Exceptions
java.util.zip.ZipException if (1) a ZIP format error has occurred or (2) targetSdkVersion >= BUILD.VERSION_CODES.UPSIDE_DOWN_CAKE and (the name argument contains ".." or starts with "/").
java.io.IOException if an I/O error has occurred
java.lang.SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file.

ZipFile

Added in API level 1
ZipFile(
    file: File!,
    mode: Int)

Opens a new ZipFile to read from the specified File object in the specified mode. The mode argument must be either OPEN_READ or OPEN_READ | OPEN_DELETE.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

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

Parameters
file File!: the ZIP file to be opened for reading
mode Int: the mode in which the file is to be opened
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred
java.lang.SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file, or its checkDelete method doesn't allow deleting the file when the OPEN_DELETE flag is set.
java.lang.IllegalArgumentException if the mode argument is invalid

ZipFile

Added in API level 1
ZipFile(file: File!)

Opens a ZIP file for reading given the specified File object.

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

Parameters
file File!: the ZIP file to be opened for reading
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred

ZipFile

Added in API level 24
ZipFile(
    file: File!,
    mode: Int,
    charset: Charset!)

Opens a new ZipFile to read from the specified File object in the specified mode. The mode argument must be either OPEN_READ or OPEN_READ | OPEN_DELETE.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

Parameters
file File!: the ZIP file to be opened for reading
mode Int: the mode in which the file is to be opened
charset Charset!: the charset to be used to decode the ZIP entry name and comment that are not encoded by using UTF-8 encoding (indicated by entry's general purpose flag).
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred
java.lang.SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file,or its checkDelete method doesn't allow deleting the file when the OPEN_DELETE flag is set
java.lang.IllegalArgumentException if the mode argument is invalid

ZipFile

Added in API level 24
ZipFile(
    name: String!,
    charset: Charset!)

Opens a zip file for reading.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

Parameters
name String!: the name of the zip file
charset Charset!: the charset to be used to decode the ZIP entry name and comment that are not encoded by using UTF-8 encoding (indicated by entry's general purpose flag).
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred
java.lang.SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file

ZipFile

Added in API level 24
ZipFile(
    file: File!,
    charset: Charset!)

Opens a ZIP file for reading given the specified File object.

Parameters
file File!: the ZIP file to be opened for reading
charset Charset!: The charset to be used to decode the ZIP entry name and comment (ignored if the language encoding bit of the ZIP entry's general purpose bit flag is set).
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred

Public methods

close

Added in API level 1
open fun close(): Unit

Closes the ZIP file.

Closing this ZIP file will close all of the input streams previously returned by invocations of the getInputStream method.

Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException if an I/O error has occurred

entries

Added in API level 1
open fun entries(): Enumeration<out ZipEntry!>!

Returns an enumeration of the ZIP file entries.

Return
Enumeration<out ZipEntry!>! an enumeration of the ZIP file entries
Exceptions
java.lang.IllegalStateException if the zip file has been closed

getComment

Added in API level 19
open fun getComment(): String!

Returns the zip file comment, or null if none.

Return
String! the comment string for the zip file, or null if none
Exceptions
java.lang.IllegalStateException if the zip file has been closed

getEntry

Added in API level 1
open fun getEntry(name: String!): ZipEntry!

Returns the zip file entry for the specified name, or null if not found.

Parameters
name String!: the name of the entry
Return
ZipEntry! the zip file entry, or null if not found
Exceptions
java.lang.IllegalStateException if the zip file has been closed

getInputStream

Added in API level 1
open fun getInputStream(entry: ZipEntry!): InputStream!

Returns an input stream for reading the contents of the specified zip file entry.

Closing this ZIP file will, in turn, close all input streams that have been returned by invocations of this method.

Parameters
entry ZipEntry!: the zip file entry
Return
InputStream! the input stream for reading the contents of the specified zip file entry.
Exceptions
java.util.zip.ZipException if a ZIP format error has occurred
java.io.IOException if an I/O error has occurred
java.lang.IllegalStateException if the zip file has been closed

getName

Added in API level 1
open fun getName(): String!

Returns the path name of the ZIP file.

Return
String! the path name of the ZIP file

size

Added in API level 1
open fun size(): Int

Returns the number of entries in the ZIP file.

Return
Int the number of entries in the ZIP file
Exceptions
java.lang.IllegalStateException if the zip file has been closed

stream

Added in API level 26
open fun stream(): Stream<out ZipEntry!>!

Returns an ordered Stream over the ZIP file entries. Entries appear in the Stream in the order they appear in the central directory of the ZIP file.

Return
Stream<out ZipEntry!>! an ordered Stream of entries in this ZIP file
Exceptions
java.lang.IllegalStateException if the zip file has been closed