Added in API level 1

JarFile

open class JarFile : ZipFile

kotlin.Any
↳	java.util.zip.ZipFile
	↳	java.util.jar.JarFile

The JarFile class is used to read the contents of a jar file from any file that can be opened with java.io.RandomAccessFile. It extends the class java.util.zip.ZipFile with support for reading an optional Manifest entry. The Manifest can be used to specify meta-information about the jar file and its entries.

Unless otherwise noted, passing a null argument to a constructor or method in this class will cause a NullPointerException to be thrown. If the verify flag is on when opening a signed jar file, the content of the file is verified against its signature embedded inside the file. Please note that the verification process does not include validating the signer's certificate. A caller should inspect the return value of JarEntry.getCodeSigners() to further determine if the signature can be trusted.

Summary

Constants
static Int	`CENATT` Central directory (CEN) header internal file attributes field offset.
static Int	`CENATX` Central directory (CEN) header external file attributes field offset.
static Int	`CENCOM` Central directory (CEN) header comment length field offset.
static Int	`CENCRC` Central directory (CEN) header uncompressed file crc-32 value field offset.
static Int	`CENDSK` Central directory (CEN) header disk number start field offset.
static Int	`CENEXT` Central directory (CEN) header extra field length field offset.
static Int	`CENFLG` Central directory (CEN) header encrypt, decrypt flags field offset.
static Int	`CENHDR` Central directory (CEN) header size in bytes (including signature).
static Int	`CENHOW` Central directory (CEN) header compression method field offset.
static Int	`CENLEN` Central directory (CEN) header uncompressed size field offset.
static Int	`CENNAM` Central directory (CEN) header filename length field offset.
static Int	`CENOFF` Central directory (CEN) header LOC header offset field offset.
static Long	`CENSIG` Central directory (CEN) header signature.
static Int	`CENSIZ` Central directory (CEN) header compressed size field offset.
static Int	`CENTIM` Central directory (CEN) header modification time field offset.
static Int	`CENVEM` Central directory (CEN) header version made by field offset.
static Int	`CENVER` Central directory (CEN) header version needed to extract field offset.
static Int	`ENDCOM` End of central directory (END) header zip file comment length field offset.
static Int	`ENDHDR` End of central directory (END) header size in bytes (including signature).
static Int	`ENDOFF` End of central directory (END) header offset for the first CEN header field offset.
static Long	`ENDSIG` End of central directory (END) header signature.
static Int	`ENDSIZ` End of central directory (END) header central directory size in bytes field offset.
static Int	`ENDSUB` End of central directory (END) header number of entries on this disk field offset.
static Int	`ENDTOT` End of central directory (END) header total number of entries field offset.
static Int	`EXTCRC` Extra local (EXT) header uncompressed file crc-32 value field offset.
static Int	`EXTHDR` Extra local (EXT) header size in bytes (including signature).
static Int	`EXTLEN` Extra local (EXT) header uncompressed size field offset.
static Long	`EXTSIG` Extra local (EXT) header signature.
static Int	`EXTSIZ` Extra local (EXT) header compressed size field offset.
static Int	`LOCCRC` Local file (LOC) header uncompressed file crc-32 value field offset.
static Int	`LOCEXT` Local file (LOC) header extra field length field offset.
static Int	`LOCFLG` Local file (LOC) header general purpose bit flag field offset.
static Int	`LOCHDR` Local file (LOC) header size in bytes (including signature).
static Int	`LOCHOW` Local file (LOC) header compression method field offset.
static Int	`LOCLEN` Local file (LOC) header uncompressed size field offset.
static Int	`LOCNAM` Local file (LOC) header filename length field offset.
static Long	`LOCSIG` Local file (LOC) header signature.
static Int	`LOCSIZ` Local file (LOC) header compressed size field offset.
static Int	`LOCTIM` Local file (LOC) header modification time field offset.
static Int	`LOCVER` Local file (LOC) header version needed to extract field offset.
static String	`MANIFEST_NAME` The JAR manifest file name.

Inherited constants

From class ZipFile

Int

OPEN_DELETE

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.

Int

OPEN_READ

Mode flag to open a zip file for reading.

Public constructors
`JarFile(file: File!)` Creates a new `JarFile` to read from the specified `File` object.
`JarFile(file: File!, verify: Boolean)` Creates a new `JarFile` to read from the specified `File` object.
`JarFile(file: File!, verify: Boolean, mode: Int)` Creates a new `JarFile` to read from the specified `File` object in the specified mode.
`JarFile(name: String!)` Creates a new `JarFile` to read from the specified file `name`.
`JarFile(name: String!, verify: Boolean)` Creates a new `JarFile` to read from the specified file `name`.

Public methods
open Enumeration<JarEntry!>!	`entries()` Returns an enumeration of the zip file entries.
open ZipEntry!	`getEntry(name: String!)` Returns the `ZipEntry` for the given entry name or `null` if not found.
open InputStream!	`getInputStream(ze: ZipEntry!)` Returns an input stream for reading the contents of the specified zip file entry.
open JarEntry!	`getJarEntry(name: String!)` Returns the `JarEntry` for the given entry name or `null` if not found.
open Manifest!	`getManifest()` Returns the jar file manifest, or `null` if none.
open Stream<JarEntry!>!	`stream()`

Inherited functions

From class ZipFile

`Unit`	`close()` Closes the ZIP file. Closing this ZIP file will close all of the input streams previously returned by invocations of the `getInputStream` method.
`String!`	`getComment()` Returns the zip file comment, or null if none.
`String!`	`getName()` Returns the path name of the ZIP file.
`Int`	`size()` Returns the number of entries in the ZIP file.

Exceptions
`java.io.IOException`	if an I/O error has occurred
`java.lang.SecurityException`	if access to the file is denied by the SecurityManager

Parameters
`file`	File!: the jar file to be opened for reading
`verify`	Boolean: whether or not to verify the jar file if it is signed.

Exceptions
`java.io.IOException`	if an I/O error has occurred
`java.lang.IllegalArgumentException`	if the mode argument is invalid
`java.lang.SecurityException`	if access to the file is denied by the SecurityManager

Parameters
`name`	String!: the name of the jar file to be opened for reading
`verify`	Boolean: whether or not to verify the jar file if it is signed.

Exceptions
`java.util.zip.ZipException`	if a zip file format error has occurred
`java.io.IOException`	if an I/O error has occurred
`java.lang.IllegalStateException`	may be thrown if the jar file has been closed
`java.lang.SecurityException`	if any of the jar file entries are incorrectly signed.

JarFile

Summary

Constants

CENATT

CENATX

CENCOM

CENCRC

CENDSK

CENEXT

CENFLG

CENHDR

CENHOW

CENLEN

CENNAM

CENOFF

CENSIG

CENSIZ

CENTIM

CENVEM

CENVER

ENDCOM

ENDHDR

ENDOFF

ENDSIG

ENDSIZ

ENDSUB

ENDTOT

EXTCRC

EXTHDR

EXTLEN

EXTSIG

EXTSIZ

LOCCRC

LOCEXT

LOCFLG

LOCHDR

LOCHOW

LOCLEN

LOCNAM

LOCSIG

LOCSIZ

LOCTIM

LOCVER

MANIFEST_NAME

Public constructors

JarFile

JarFile

JarFile

JarFile

JarFile

Public methods

entries

getEntry

getInputStream

getJarEntry

getManifest

stream