Added in API level 1

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

Inherited constants

From class java.util.zip.ZipFile

`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`
`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(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`.
`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.

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()` Return 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.
`void`	`finalize()` Ensures that the system resources held by this ZipFile object are released when there are no more references to it.
`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()` Return 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          java.io.Closeable


      close()

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

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Constants

CENATT

Added in API level 21

public static final int CENATT

Constant Value: 36 (0x00000024)

CENATX

Added in API level 21

public static final int CENATX

Constant Value: 38 (0x00000026)

CENCOM

Added in API level 21

public static final int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

Added in API level 21

public static final int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

Added in API level 21

public static final int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

Added in API level 21

public static final int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

Added in API level 21

public static final int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

Added in API level 21

public static final int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

Added in API level 21

public static final int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

Added in API level 21

public static final int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

Added in API level 21

public static final int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

Added in API level 21

public static final int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

Added in API level 21

public static final long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

Added in API level 21

public static final int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

Added in API level 21

public static final int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

Added in API level 21

public static final int CENVEM

Constant Value: 4 (0x00000004)

CENVER

Added in API level 21

public static final int CENVER

Constant Value: 6 (0x00000006)

ENDCOM

Added in API level 21

public static final int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

Added in API level 21

public static final int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

Added in API level 21

public static final int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

Added in API level 21

public static final long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

Added in API level 21

public static final int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

Added in API level 21

public static final int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

Added in API level 21

public static final int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

Added in API level 21

public static final int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

Added in API level 21

public static final int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

Added in API level 21

public static final int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

Added in API level 21

public static final long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

Added in API level 21

public static final int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

Added in API level 21

public static final int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

Added in API level 21

public static final int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

Added in API level 21

public static final int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

Added in API level 21

public static final int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

Added in API level 21

public static final int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

Added in API level 21

public static final int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

Added in API level 21

public static final int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

Added in API level 21

public static final long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

Added in API level 21

public static final int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

Added in API level 21

public static final int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

Added in API level 21

public static final int LOCVER

Constant Value: 4 (0x00000004)

MANIFEST_NAME

Added in API level 1

public static final String MANIFEST_NAME

The JAR manifest file name.

Constant Value: "META-INF/MANIFEST.MF"

Public constructors

JarFile

Added in API level 1

public JarFile (String name)

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

Throws
`IOException`	if an I/O error has occurred
`SecurityException`	if access to the file is denied by the SecurityManager

JarFile

Added in API level 1

public JarFile (String name, 
                boolean verify)

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.

Throws
`IOException`	if an I/O error has occurred
`SecurityException`	if access to the file is denied by the SecurityManager

JarFile

Added in API level 1

public 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

Throws
`IOException`	if an I/O error has occurred
`SecurityException`	if access to the file is denied by the SecurityManager

JarFile

Added in API level 1

public JarFile (File file, 
                boolean verify)

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.

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

JarFile

Added in API level 1

public JarFile (File file, 
                boolean verify, 
                int mode)

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

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

Public methods

entries

Added in API level 1

public Enumeration<JarEntry> entries ()

Returns an enumeration of the zip file entries.

Returns
`Enumeration<JarEntry>`	an enumeration of the ZIP file entries

getEntry

Added in API level 1

public ZipEntry getEntry (String name)

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

Parameters
`name`	`String`: the jar file entry name

Returns
`ZipEntry`	the `ZipEntry` for the given entry name or `null` if not found

Throws
`IllegalStateException`	may be thrown if the jar file has been closed

See also:

ZipEntry

getInputStream

Added in API level 1

public InputStream getInputStream (ZipEntry ze)

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

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

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

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

getJarEntry

Added in API level 1

public JarEntry getJarEntry (String name)

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

Parameters
`name`	`String`: the jar file entry name

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

Throws
`IllegalStateException`	may be thrown if the jar file has been closed

See also:

JarEntry

getManifest

Added in API level 1

public Manifest getManifest ()

Returns the jar file manifest, or null if none.

Returns
`Manifest`	the jar file manifest, or `null` if none

Throws
`IllegalStateException`	may be thrown if the jar file has been closed
`IOException`	if an I/O error has occurred

stream

Added in API level 26

public Stream<JarEntry> stream ()

Return 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.

Returns
`Stream<JarEntry>`	an ordered `Stream` of entries in this ZIP file