Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 1

public class

JarFile

extends ZipFile

java.lang.Object
↳	java.util.zip.ZipFile
	↳	java.util.jar.JarFile

Class Overview

JarFile is used to read jar entries and their associated data from jar files.

Summary

Constants
String	MANIFEST_NAME	The MANIFEST file name.

[Expand]

Inherited Constants

From class java.util.zip.ZipFile

Public Constructors
	JarFile ( File file) Create a new `JarFile` using the contents of the specified file.
	JarFile ( File file, boolean verify) Create a new `JarFile` using the contents of the specified file.
	JarFile ( File file, boolean verify, int mode) Create a new `JarFile` using the contents of file.
	JarFile ( String filename) Create a new `JarFile` from the contents of the file specified by filename.
	JarFile ( String filename, boolean verify) Create a new `JarFile` from the contents of the file specified by `filename` .

Public Methods
void	close () Closes this `JarFile` .
Enumeration < JarEntry >	entries () Return an enumeration containing the `JarEntrys` contained in this `JarFile` .
ZipEntry	getEntry ( String name) Return the `JarEntry` specified by name or `null` if no such entry exists.
InputStream	getInputStream ( ZipEntry ze) Return an `InputStream` for reading the decompressed contents of ZIP entry.
JarEntry	getJarEntry ( String name) Return the `JarEntry` specified by its name or `null` if no such entry exists.
Manifest	getManifest () Returns the `Manifest` object associated with this `JarFile` or `null` if no MANIFEST entry exists.

[Expand]

Inherited Methods

From class java.util.zip.ZipFile

void	close () Closes this zip file.
Enumeration <? extends ZipEntry >	entries () Returns an enumeration of the entries.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
String	getComment () Returns this file's comment, or null if it doesn't have one.
ZipEntry	getEntry ( String entryName) Returns the zip entry with the given name, or null if there is no such entry.
InputStream	getInputStream ( ZipEntry entry) Returns an input stream on the data of the specified `ZipEntry` .
String	getName () Gets the file name of this `ZipFile` .
int	size () Returns the number of `ZipEntries` in this `ZipFile` .

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Constants

public static final String MANIFEST_NAME

Added in API level 1

The MANIFEST file name.

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

Public Constructors

public JarFile ( File file)

Added in API level 1

Create a new JarFile using the contents of the specified file.

Parameters

file	the JAR file as `File` .

Throws

IOException	If the file cannot be read.

public JarFile ( File file, boolean verify)

Added in API level 1

Create a new JarFile using the contents of the specified file.

Parameters

file	the JAR file as `File` .
verify	if this JAR file is signed whether it must be verified.

Throws

IOException	If the file cannot be read.

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

Added in API level 1

Create a new JarFile using the contents of file.

Parameters

file	the JAR file as `File` .
verify	if this JAR filed is signed whether it must be verified.
mode	the mode to use, either `OPEN_READ` or `OPEN_DELETE` .

Throws

IOException	If the file cannot be read.

public JarFile ( String filename)

Added in API level 1

Create a new JarFile from the contents of the file specified by filename.

Parameters

filename	the file name referring to the JAR file.

Throws

IOException	if file name cannot be opened for reading.

public JarFile ( String filename, boolean verify)

Added in API level 1

Create a new JarFile from the contents of the file specified by filename .

Parameters

filename	the file name referring to the JAR file.
verify	if this JAR filed is signed whether it must be verified.

Throws

IOException	If file cannot be opened or read.

Public Methods

public void close ()

Added in API level 1

Closes this JarFile .

Throws

IOException	if an error occurs.

public Enumeration < JarEntry > entries ()

Added in API level 1

Return an enumeration containing the JarEntrys contained in this JarFile .

Returns

the Enumeration containing the JAR entries.

Throws

IllegalStateException	if this `JarFile` is closed.

public ZipEntry getEntry ( String name)

Added in API level 1

Return the JarEntry specified by name or null if no such entry exists.

Parameters

name	the name of the entry in the JAR file.

Returns

the ZIP entry extracted.

public InputStream getInputStream ( ZipEntry ze)

Added in API level 1

Return an InputStream for reading the decompressed contents of ZIP entry.

Parameters

ze	the ZIP entry to be read.

Returns

the input stream to read from.

Throws

IOException	if an error occurred while creating the input stream.

public JarEntry getJarEntry ( String name)

Added in API level 1

Return the JarEntry specified by its name or null if no such entry exists.

Parameters

name	the name of the entry in the JAR file.

Returns

the JAR entry defined by the name.

public Manifest getManifest ()

Added in API level 1

Returns the Manifest object associated with this JarFile or null if no MANIFEST entry exists.

Returns

the MANIFEST.

Throws

IOException	if an error occurs reading the MANIFEST file.
IllegalStateException	if the jar file is closed.

Results

Interfaces

Classes

Exceptions

JarFile

Class Overview

See Also

Summary

Constants

public static final String MANIFEST_NAME

Public Constructors

public JarFile ( File file)

Parameters

Throws

public JarFile ( File file, boolean verify)

Parameters

Throws

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

Parameters

Throws

public JarFile ( String filename)

Parameters

Throws

public JarFile ( String filename, boolean verify)

Parameters

Throws

Public Methods

public void close ()

Throws

public Enumeration < JarEntry > entries ()

Returns

Throws

public ZipEntry getEntry ( String name)

Parameters

Returns

public InputStream getInputStream ( ZipEntry ze)

Parameters

Returns

Throws

public JarEntry getJarEntry ( String name)

Parameters

Returns

public Manifest getManifest ()

Returns

Throws

See Also