# Print output for @column tags ?> JarFile - Android SDK | Android Developers

Most visited

Recently visited

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

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

Constants

CENATT

public static final int CENATT

Constant Value: 36 (0x00000024)

CENATX

public static final int CENATX

Constant Value: 38 (0x00000026)

CENCOM

public static final int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

public static final int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

public static final int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

public static final int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

public static final int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

public static final int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

public static final int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

public static final int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

public static final int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

public static final int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

public static final long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

public static final int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

public static final int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

public static final int CENVEM

Constant Value: 4 (0x00000004)

CENVER

public static final int CENVER

Constant Value: 6 (0x00000006)

ENDCOM

public static final int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

public static final int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

public static final int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

public static final long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

public static final int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

public static final int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

public static final int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

public static final int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

public static final int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

public static final int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

public static final long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

public static final int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

public static final int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

public static final int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

public static final int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

public static final int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

public static final int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

public static final int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

public static final int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

public static final long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

public static final int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

public static final int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

public static final int LOCVER

Constant Value: 4 (0x00000004)

MANIFEST_NAME

public static final String MANIFEST_NAME

The JAR manifest file name.

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

Public constructors

JarFile

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

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

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

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

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

public Enumeration<JarEntry> entries ()

Returns an enumeration of the zip file entries.

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

getEntry

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:

getInputStream

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

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:

getManifest

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

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