Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

JarFile

public class JarFile
extends ZipFile

java.lang.Object
↳	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.

See also:

Summary

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

Inherited constants

From class java.util.zip.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.
`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, boolean verify)` Creates a new `JarFile` to read from the specified `File` object.
`JarFile(File file, boolean verify, int mode)` Creates a new `JarFile` to read from the specified `File` object in the specified mode.
`JarFile(String name)` Creates a new `JarFile` to read from the specified file `name`.
`JarFile(String name, boolean verify)` Creates a new `JarFile` to read from the specified file `name`.

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

Inherited methods

From class java.util.zip.ZipFile

`void`	`close()` Closes the ZIP file.
`Enumeration<? extends ZipEntry>`	`entries()` Returns an enumeration of the ZIP file entries.
`String`	`getComment()` Returns the zip file comment, or null if none.
`ZipEntry`	`getEntry(String name)` Returns the zip file entry for the specified name, or null if not found.
`InputStream`	`getInputStream(ZipEntry entry)` Returns an input stream for reading the contents of the specified zip file entry.
`String`	`getName()` Returns the path name of the ZIP file.
`int`	`size()` Returns the number of entries in the ZIP file.
`Stream<? extends ZipEntry>`	`stream()` Returns an ordered `Stream` over the ZIP file entries.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface java.io.Closeable

abstract void

close()

Closes this stream and releases any system resources associated with it.

From interface java.lang.AutoCloseable

abstract void

close()

Closes this resource, relinquishing any underlying resources.

Throws
`IOException`	if an I/O error has occurred
`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.

Throws
`IOException`	if an I/O error has occurred
`IllegalArgumentException`	if the `mode` argument is invalid
`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.

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

JarFile

Summary

Constants

Inherited constants

Public constructors

Public methods

Inherited methods

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