Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.util.jar.JarFile

java.lang.Object
    |
    +----java.util.zip.ZipFile
            |
            +----java.util.jar.JarFile

public class JarFile
extends ZipFile
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.

Since:
JDK1.2
See Also:
Manifest, ZipFile, JarEntry

Field Summary
static String  MANIFEST_NAME
 
 

Constructor Summary
 JarFile()
Creates a new, unnamed JarFile.
 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.
 

Method Summary
ZipEntry  createZipEntry(String name)
Creates a new JarEntry for the specified JAR file entry name.
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.
Manifest  getManifest()
Returns the JAR file manifest, or null if none.
JarEntry  getManifestEntry()
Returns the JarEntry for the manifest, or null if none.
 
Methods inherited from class java.util.zip.ZipFile
 close, createZipEntry, entries, getEntry, getInputStream, getName, size
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MANIFEST_NAME

public static final String MANIFEST_NAME
Constructor Detail

JarFile

protected JarFile()
Creates a new, unnamed JarFile.

JarFile

public JarFile(String name) throws IOException
Creates a new JarFile to read from the specified file name. The JarFile will be verified if it is signed.
Parameters:
name - the name of the JAR file to be opened for reading
Throws:
FileNotFoundException - if the file could not be found
IOException - if an I/O error has occurred

JarFile

public JarFile(String name,
               boolean verify) throws IOException
Creates a new JarFile to read from the specified file name.
Parameters:
name - the name of the JAR file to be opened for reading
verify - whether or not to verify the JarFile if it is signed.
Throws:
FileNotFoundException - if the file could not be found
IOException - if an I/O error has occurred

JarFile

public JarFile(File file) throws IOException
Creates a new JarFile to read from the specified File object. The JarFile will be verified if it is signed.
Parameters:
file - the JAR file to be opened for reading
Throws:
FileNotFoundException - if the file could not be found
IOException - if an I/O error has occurred

JarFile

public JarFile(File file,
               boolean verify) throws IOException
Creates a new JarFile to read from the specified File object.
Parameters:
file - the JAR file to be opened for reading
verify - whether or not to verify the JarFile if it is signed.
Throws:
FileNotFoundException - if the file could not be found
IOException - if an I/O error has occurred
Method Detail

getManifest

public Manifest getManifest()
Returns the JAR file manifest, or null if none.

getManifestEntry

public JarEntry getManifestEntry()
Returns the JarEntry for the manifest, or null if none.

getJarEntry

public JarEntry getJarEntry(String name)
Returns the JarEntry for the given entry name. Returns null if there is no entry corresponding to the given name.
Parameters:
name - the JAR file entry name
See Also:
JarEntry

getInputStream

public InputStream getInputStream(ZipEntry ze) throws IOException
Returns an input stream for reading the contents of the specified ZIP file entry.
Parameters:
ze - the zip file entry
Throws:
ZipException - if a ZIP format error has occurred
IOException - if an I/O error has occurred
Overrides:
getInputStream in class ZipFile

createZipEntry

protected ZipEntry createZipEntry(String name)
Creates a new JarEntry for the specified JAR file entry name.
Overrides:
createZipEntry in class ZipFile

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.