JavaTM 2 Platform
Standard Edition

java.util.jar
Class 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(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(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.
 
Method Summary
 Enumeration entries()
          Returns an enumeration of the ZIP file entries.
 ZipEntry getEntry(String name)
          Returns the zip file entry for the specified 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.
 
Methods inherited from class java.util.zip.ZipFile
close, 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

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()
                     throws IOException
Returns the JAR file manifest, or null if none.

getJarEntry

public JarEntry getJarEntry(String name)
Returns the JarEntry for the given entry name or null if not found.
Parameters:
name - the JAR file entry name
See Also:
JarEntry

getEntry

public ZipEntry getEntry(String name)
Description copied from class: ZipFile
Returns the zip file entry for the specified name, or null if not found.
Overrides:
getEntry in class ZipFile
Tags copied from class: ZipFile
Parameters:
name - the name of the entry
Returns:
the zip file entry, or null if not found
Throws:
IllegalStateException - if the zip file has been closed

entries

public Enumeration entries()
Description copied from class: ZipFile
Returns an enumeration of the ZIP file entries.
Overrides:
entries in class ZipFile
Tags copied from class: ZipFile
Throws:
IllegalStateException - if the zip file has been closed

getInputStream

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

JavaTM 2 Platform
Standard Edition

Submit a bug or feature
Java, Java 2D, and JDBC are a trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.