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 String	MANIFEST_NAME The JAR manifest file name.

Inherited constants

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

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.

Constants

MANIFEST_NAME

Added in API level 1

static val MANIFEST_NAME: String

The JAR manifest file name.

Value: "META-INF/MANIFEST.MF"

Public constructors

JarFile

Added in API level 1

JarFile(file: File!)

Creates a new JarFile to read from the specified File object. The JarFile will be verified if it is signed.

Parameters
file	File!: the jar file to be opened for reading

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

JarFile

Added in API level 1

JarFile(
    file: File!, 
    verify: Boolean)

Creates a new JarFile to read from the specified File object.

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.SecurityException	if access to the file is denied by the SecurityManager.

JarFile

Added in API level 1

JarFile(
    file: File!, 
    verify: Boolean, 
    mode: Int)

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

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.
mode	Int: the mode in which the file is to be opened

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

JarFile

Added in API level 1

JarFile(name: String!)

Creates a new JarFile to read from the specified file name. The JarFile will be verified if it is signed.

Parameters
name	String!: the name of the jar file to be opened for reading

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

JarFile

Added in API level 1

JarFile(
    name: String!, 
    verify: Boolean)

Creates a new JarFile to read from the specified file name.

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.io.IOException	if an I/O error has occurred
java.lang.SecurityException	if access to the file is denied by the SecurityManager

Public methods

entries

Added in API level 1

open fun entries(): Enumeration<JarEntry!>!

Returns an enumeration of the zip file entries.

Return
Enumeration<JarEntry!>!	an enumeration of the ZIP file entries

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 ZipEntry for the given entry name or null if not found.

Parameters
name	String!: the jar file entry name

Return
ZipEntry!	the ZipEntry for the given entry name or null if not found

Exceptions
java.lang.IllegalStateException	may be thrown if the jar file has been closed

See Also

• java.util.zip.ZipEntry

getInputStream

Added in API level 1

open fun getInputStream(ze: ZipEntry!): InputStream!

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

Parameters
entry	the zip file entry
ze	ZipEntry!: the zip file entry

Return
InputStream!	an input stream for reading the contents of the specified zip file entry

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

getJarEntry

Added in API level 1

open fun getJarEntry(name: String!): JarEntry!

Returns the JarEntry for the given entry name or null if not found.

Parameters
name	String!: the jar file entry name

Return
JarEntry!	the JarEntry for the given entry name or null if not found.

Exceptions
java.lang.IllegalStateException	may be thrown if the jar file has been closed

See Also

• java.util.jar.JarEntry

getManifest

Added in API level 1

open fun getManifest(): Manifest!

Returns the jar file manifest, or null if none.

Return
Manifest!	the jar file manifest, or null if none

Exceptions
java.io.IOException	if an I/O error has occurred
java.lang.IllegalStateException	may be thrown if the jar file has been closed

stream

Added in API level 26

open fun stream(): Stream<JarEntry!>!

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<JarEntry!>!	an ordered Stream of entries in this ZIP file

Exceptions
java.lang.IllegalStateException	if the zip file has been closed