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.
Constants | |
|---|---|
String |
MANIFEST_NAME
The JAR manifest file name. |
Inherited constants |
|---|
java.util.zip.ZipFile
|
Public constructors | |
|---|---|
JarFile(String name)
Creates a new |
|
JarFile(String name, boolean verify)
Creates a new |
|
JarFile(File file)
Creates a new |
|
JarFile(File file, boolean verify)
Creates a new |
|
JarFile(File file, boolean verify, int mode)
Creates a new |
|
Public methods | |
|---|---|
Enumeration<JarEntry>
|
entries()
Returns an enumeration of the zip file entries. |
ZipEntry
|
getEntry(String name)
Returns the |
InputStream
|
getInputStream(ZipEntry ze)
Returns an input stream for reading the contents of the specified zip file entry. |
JarEntry
|
getJarEntry(String name)
Returns the |
Manifest
|
getManifest()
Returns the jar file manifest, or |
Inherited methods | |
|---|---|
java.util.zip.ZipFile
| |
java.lang.Object
| |
java.io.Closeable
| |
java.lang.AutoCloseable
| |
String MANIFEST_NAME
The JAR manifest file name.
Constant Value: "META-INF/MANIFEST.MF"
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 (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 (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 (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 (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 |
Enumeration<JarEntry> entries ()
Returns an enumeration of the zip file entries.
| Returns | |
|---|---|
Enumeration<JarEntry> |
an enumeration of the ZIP file entries |
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:
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 |
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:
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 |
|