Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.util.jar
Class JarFile

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.zip.ZipFile sample code for java.util.zip.ZipFile definition code for java.util.zip.ZipFile 
      extended by java.util.jar.JarFile

public class JarFile
extends ZipFile sample code for java.util.zip.ZipFile definition code for java.util.zip.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.

Unless otherwise noted, passing a null argument to a constructor or method in this class will cause a NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException to be thrown.

Since:
1.2
See Also:
Manifest sample code for java.util.jar.Manifest definition code for java.util.jar.Manifest , ZipFile sample code for java.util.zip.ZipFile definition code for java.util.zip.ZipFile , JarEntry sample code for java.util.jar.JarEntry definition code for java.util.jar.JarEntry

Field Summary
static int CENATT sample code for java.util.jar.JarFile.CENATT definition code for java.util.jar.JarFile.CENATT
           
static int CENATX sample code for java.util.jar.JarFile.CENATX definition code for java.util.jar.JarFile.CENATX
           
static int CENCOM sample code for java.util.jar.JarFile.CENCOM definition code for java.util.jar.JarFile.CENCOM
           
static int CENCRC sample code for java.util.jar.JarFile.CENCRC definition code for java.util.jar.JarFile.CENCRC
           
static int CENDSK sample code for java.util.jar.JarFile.CENDSK definition code for java.util.jar.JarFile.CENDSK
           
static int CENEXT sample code for java.util.jar.JarFile.CENEXT definition code for java.util.jar.JarFile.CENEXT
           
static int CENFLG sample code for java.util.jar.JarFile.CENFLG definition code for java.util.jar.JarFile.CENFLG
           
static int CENHDR sample code for java.util.jar.JarFile.CENHDR definition code for java.util.jar.JarFile.CENHDR
           
static int CENHOW sample code for java.util.jar.JarFile.CENHOW definition code for java.util.jar.JarFile.CENHOW
           
static int CENLEN sample code for java.util.jar.JarFile.CENLEN definition code for java.util.jar.JarFile.CENLEN
           
static int CENNAM sample code for java.util.jar.JarFile.CENNAM definition code for java.util.jar.JarFile.CENNAM
           
static int CENOFF sample code for java.util.jar.JarFile.CENOFF definition code for java.util.jar.JarFile.CENOFF
           
static long CENSIG sample code for java.util.jar.JarFile.CENSIG definition code for java.util.jar.JarFile.CENSIG
           
static int CENSIZ sample code for java.util.jar.JarFile.CENSIZ definition code for java.util.jar.JarFile.CENSIZ
           
static int CENTIM sample code for java.util.jar.JarFile.CENTIM definition code for java.util.jar.JarFile.CENTIM
           
static int CENVEM sample code for java.util.jar.JarFile.CENVEM definition code for java.util.jar.JarFile.CENVEM
           
static int CENVER sample code for java.util.jar.JarFile.CENVER definition code for java.util.jar.JarFile.CENVER
           
static int ENDCOM sample code for java.util.jar.JarFile.ENDCOM definition code for java.util.jar.JarFile.ENDCOM
           
static int ENDHDR sample code for java.util.jar.JarFile.ENDHDR definition code for java.util.jar.JarFile.ENDHDR
           
static int ENDOFF sample code for java.util.jar.JarFile.ENDOFF definition code for java.util.jar.JarFile.ENDOFF
           
static long ENDSIG sample code for java.util.jar.JarFile.ENDSIG definition code for java.util.jar.JarFile.ENDSIG
           
static int ENDSIZ sample code for java.util.jar.JarFile.ENDSIZ definition code for java.util.jar.JarFile.ENDSIZ
           
static int ENDSUB sample code for java.util.jar.JarFile.ENDSUB definition code for java.util.jar.JarFile.ENDSUB
           
static int ENDTOT sample code for java.util.jar.JarFile.ENDTOT definition code for java.util.jar.JarFile.ENDTOT
           
static int EXTCRC sample code for java.util.jar.JarFile.EXTCRC definition code for java.util.jar.JarFile.EXTCRC
           
static int EXTHDR sample code for java.util.jar.JarFile.EXTHDR definition code for java.util.jar.JarFile.EXTHDR
           
static int EXTLEN sample code for java.util.jar.JarFile.EXTLEN definition code for java.util.jar.JarFile.EXTLEN
           
static long EXTSIG sample code for java.util.jar.JarFile.EXTSIG definition code for java.util.jar.JarFile.EXTSIG
           
static int EXTSIZ sample code for java.util.jar.JarFile.EXTSIZ definition code for java.util.jar.JarFile.EXTSIZ
           
static int LOCCRC sample code for java.util.jar.JarFile.LOCCRC definition code for java.util.jar.JarFile.LOCCRC
           
static int LOCEXT sample code for java.util.jar.JarFile.LOCEXT definition code for java.util.jar.JarFile.LOCEXT
           
static int LOCFLG sample code for java.util.jar.JarFile.LOCFLG definition code for java.util.jar.JarFile.LOCFLG
           
static int LOCHDR sample code for java.util.jar.JarFile.LOCHDR definition code for java.util.jar.JarFile.LOCHDR
           
static int LOCHOW sample code for java.util.jar.JarFile.LOCHOW definition code for java.util.jar.JarFile.LOCHOW
           
static int LOCLEN sample code for java.util.jar.JarFile.LOCLEN definition code for java.util.jar.JarFile.LOCLEN
           
static int LOCNAM sample code for java.util.jar.JarFile.LOCNAM definition code for java.util.jar.JarFile.LOCNAM
           
static long LOCSIG sample code for java.util.jar.JarFile.LOCSIG definition code for java.util.jar.JarFile.LOCSIG
           
static int LOCSIZ sample code for java.util.jar.JarFile.LOCSIZ definition code for java.util.jar.JarFile.LOCSIZ
           
static int LOCTIM sample code for java.util.jar.JarFile.LOCTIM definition code for java.util.jar.JarFile.LOCTIM
           
static int LOCVER sample code for java.util.jar.JarFile.LOCVER definition code for java.util.jar.JarFile.LOCVER
           
static String sample code for java.lang.String definition code for java.lang.String MANIFEST_NAME sample code for java.util.jar.JarFile.MANIFEST_NAME definition code for java.util.jar.JarFile.MANIFEST_NAME
          The JAR manifest file name.
 
Fields inherited from class java.util.zip.ZipFile sample code for java.util.zip.ZipFile definition code for java.util.zip.ZipFile
OPEN_DELETE sample code for java.util.zip.ZipFile.OPEN_DELETE definition code for java.util.zip.ZipFile.OPEN_DELETE , OPEN_READ sample code for java.util.zip.ZipFile.OPEN_READ definition code for java.util.zip.ZipFile.OPEN_READ
 
Constructor Summary
JarFile sample code for java.util.jar.JarFile.JarFile(java.io.File) definition code for java.util.jar.JarFile.JarFile(java.io.File) (File sample code for java.io.File definition code for java.io.File  file)
          Creates a new JarFile to read from the specified File object.
JarFile sample code for java.util.jar.JarFile.JarFile(java.io.File, boolean) definition code for java.util.jar.JarFile.JarFile(java.io.File, boolean) (File sample code for java.io.File definition code for java.io.File  file, boolean verify)
          Creates a new JarFile to read from the specified File object.
JarFile sample code for java.util.jar.JarFile.JarFile(java.io.File, boolean, int) definition code for java.util.jar.JarFile.JarFile(java.io.File, boolean, int) (File sample code for java.io.File definition code for java.io.File  file, boolean verify, int mode)
          Creates a new JarFile to read from the specified File object in the specified mode.
JarFile sample code for java.util.jar.JarFile.JarFile(java.lang.String) definition code for java.util.jar.JarFile.JarFile(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  name)
          Creates a new JarFile to read from the specified file name.
JarFile sample code for java.util.jar.JarFile.JarFile(java.lang.String, boolean) definition code for java.util.jar.JarFile.JarFile(java.lang.String, boolean) (String sample code for java.lang.String definition code for java.lang.String  name, boolean verify)
          Creates a new JarFile to read from the specified file name.
 
Method Summary
 Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <JarEntry sample code for java.util.jar.JarEntry definition code for java.util.jar.JarEntry > entries sample code for java.util.jar.JarFile.entries() definition code for java.util.jar.JarFile.entries() ()
          Returns an enumeration of the zip file entries.
 ZipEntry sample code for java.util.zip.ZipEntry definition code for java.util.zip.ZipEntry getEntry sample code for java.util.jar.JarFile.getEntry(java.lang.String) definition code for java.util.jar.JarFile.getEntry(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  name)
          Returns the ZipEntry for the given entry name or null if not found.
 InputStream sample code for java.io.InputStream definition code for java.io.InputStream getInputStream sample code for java.util.jar.JarFile.getInputStream(java.util.zip.ZipEntry) definition code for java.util.jar.JarFile.getInputStream(java.util.zip.ZipEntry) (ZipEntry sample code for java.util.zip.ZipEntry definition code for java.util.zip.ZipEntry  ze)
          Returns an input stream for reading the contents of the specified zip file entry.
 JarEntry sample code for java.util.jar.JarEntry definition code for java.util.jar.JarEntry getJarEntry sample code for java.util.jar.JarFile.getJarEntry(java.lang.String) definition code for java.util.jar.JarFile.getJarEntry(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  name)
          Returns the JarEntry for the given entry name or null if not found.
 Manifest sample code for java.util.jar.Manifest definition code for java.util.jar.Manifest getManifest sample code for java.util.jar.JarFile.getManifest() definition code for java.util.jar.JarFile.getManifest() ()
          Returns the jar file manifest, or null if none.
 
Methods inherited from class java.util.zip.ZipFile sample code for java.util.zip.ZipFile definition code for java.util.zip.ZipFile
close sample code for java.util.zip.ZipFile.close() definition code for java.util.zip.ZipFile.close() , finalize sample code for java.util.zip.ZipFile.finalize() definition code for java.util.zip.ZipFile.finalize() , getName sample code for java.util.zip.ZipFile.getName() definition code for java.util.zip.ZipFile.getName() , size sample code for java.util.zip.ZipFile.size() definition code for java.util.zip.ZipFile.size()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

MANIFEST_NAME sample code for java.util.jar.JarFile.MANIFEST_NAME 

public static final String sample code for java.lang.String definition code for java.lang.String  MANIFEST_NAME
The JAR manifest file name.

See Also:
Constant Field Values

LOCSIG sample code for java.util.zip.ZipConstants.LOCSIG 

public static final long LOCSIG
See Also:
Constant Field Values

EXTSIG sample code for java.util.zip.ZipConstants.EXTSIG 

public static final long EXTSIG
See Also:
Constant Field Values

CENSIG sample code for java.util.zip.ZipConstants.CENSIG 

public static final long CENSIG
See Also:
Constant Field Values

ENDSIG sample code for java.util.zip.ZipConstants.ENDSIG 

public static final long ENDSIG
See Also:
Constant Field Values

LOCHDR sample code for java.util.zip.ZipConstants.LOCHDR 

public static final int LOCHDR
See Also:
Constant Field Values

EXTHDR sample code for java.util.zip.ZipConstants.EXTHDR 

public static final int EXTHDR
See Also:
Constant Field Values

CENHDR sample code for java.util.zip.ZipConstants.CENHDR 

public static final int CENHDR
See Also:
Constant Field Values

ENDHDR sample code for java.util.zip.ZipConstants.ENDHDR 

public static final int ENDHDR
See Also:
Constant Field Values

LOCVER sample code for java.util.zip.ZipConstants.LOCVER 

public static final int LOCVER
See Also:
Constant Field Values

LOCFLG sample code for java.util.zip.ZipConstants.LOCFLG 

public static final int LOCFLG
See Also:
Constant Field Values

LOCHOW sample code for java.util.zip.ZipConstants.LOCHOW 

public static final int LOCHOW
See Also:
Constant Field Values

LOCTIM sample code for java.util.zip.ZipConstants.LOCTIM 

public static final int LOCTIM
See Also:
Constant Field Values

LOCCRC sample code for java.util.zip.ZipConstants.LOCCRC 

public static final int LOCCRC
See Also:
Constant Field Values

LOCSIZ sample code for java.util.zip.ZipConstants.LOCSIZ 

public static final int LOCSIZ
See Also:
Constant Field Values

LOCLEN sample code for java.util.zip.ZipConstants.LOCLEN 

public static final int LOCLEN
See Also:
Constant Field Values

LOCNAM sample code for java.util.zip.ZipConstants.LOCNAM 

public static final int LOCNAM
See Also:
Constant Field Values

LOCEXT sample code for java.util.zip.ZipConstants.LOCEXT 

public static final int LOCEXT
See Also:
Constant Field Values

EXTCRC sample code for java.util.zip.ZipConstants.EXTCRC 

public static final int EXTCRC
See Also:
Constant Field Values

EXTSIZ sample code for java.util.zip.ZipConstants.EXTSIZ 

public static final int EXTSIZ
See Also:
Constant Field Values

EXTLEN sample code for java.util.zip.ZipConstants.EXTLEN 

public static final int EXTLEN
See Also:
Constant Field Values

CENVEM sample code for java.util.zip.ZipConstants.CENVEM 

public static final int CENVEM
See Also:
Constant Field Values

CENVER sample code for java.util.zip.ZipConstants.CENVER 

public static final int CENVER
See Also:
Constant Field Values

CENFLG sample code for java.util.zip.ZipConstants.CENFLG 

public static final int CENFLG
See Also:
Constant Field Values

CENHOW sample code for java.util.zip.ZipConstants.CENHOW 

public static final int CENHOW
See Also:
Constant Field Values

CENTIM sample code for java.util.zip.ZipConstants.CENTIM 

public static final int CENTIM
See Also:
Constant Field Values

CENCRC sample code for java.util.zip.ZipConstants.CENCRC 

public static final int CENCRC
See Also:
Constant Field Values

CENSIZ sample code for java.util.zip.ZipConstants.CENSIZ 

public static final int CENSIZ
See Also:
Constant Field Values

CENLEN sample code for java.util.zip.ZipConstants.CENLEN 

public static final int CENLEN
See Also:
Constant Field Values

CENNAM sample code for java.util.zip.ZipConstants.CENNAM 

public static final int CENNAM
See Also:
Constant Field Values

CENEXT sample code for java.util.zip.ZipConstants.CENEXT 

public static final int CENEXT
See Also:
Constant Field Values

CENCOM sample code for java.util.zip.ZipConstants.CENCOM 

public static final int CENCOM
See Also:
Constant Field Values

CENDSK sample code for java.util.zip.ZipConstants.CENDSK 

public static final int CENDSK
See Also:
Constant Field Values

CENATT sample code for java.util.zip.ZipConstants.CENATT 

public static final int CENATT
See Also:
Constant Field Values

CENATX sample code for java.util.zip.ZipConstants.CENATX 

public static final int CENATX
See Also:
Constant Field Values

CENOFF sample code for java.util.zip.ZipConstants.CENOFF 

public static final int CENOFF
See Also:
Constant Field Values

ENDSUB sample code for java.util.zip.ZipConstants.ENDSUB 

public static final int ENDSUB
See Also:
Constant Field Values

ENDTOT sample code for java.util.zip.ZipConstants.ENDTOT 

public static final int ENDTOT
See Also:
Constant Field Values

ENDSIZ sample code for java.util.zip.ZipConstants.ENDSIZ 

public static final int ENDSIZ
See Also:
Constant Field Values

ENDOFF sample code for java.util.zip.ZipConstants.ENDOFF 

public static final int ENDOFF
See Also:
Constant Field Values

ENDCOM sample code for java.util.zip.ZipConstants.ENDCOM 

public static final int ENDCOM
See Also:
Constant Field Values
Constructor Detail

JarFile sample code for java.util.jar.JarFile(java.lang.String) definition code for java.util.jar.JarFile(java.lang.String) 

public JarFile(String sample code for java.lang.String definition code for java.lang.String  name)
        throws IOException sample code for java.io.IOException definition code for java.io.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:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error has occurred
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if access to the file is denied by the SecurityManager

JarFile sample code for java.util.jar.JarFile(java.lang.String, boolean) definition code for java.util.jar.JarFile(java.lang.String, boolean) 

public JarFile(String sample code for java.lang.String definition code for java.lang.String  name,
               boolean verify)
        throws IOException sample code for java.io.IOException definition code for java.io.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 jar file if it is signed.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error has occurred
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if access to the file is denied by the SecurityManager

JarFile sample code for java.util.jar.JarFile(java.io.File) definition code for java.util.jar.JarFile(java.io.File) 

public JarFile(File sample code for java.io.File definition code for java.io.File  file)
        throws IOException sample code for java.io.IOException definition code for java.io.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:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error has occurred
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if access to the file is denied by the SecurityManager

JarFile sample code for java.util.jar.JarFile(java.io.File, boolean) definition code for java.util.jar.JarFile(java.io.File, boolean) 

public JarFile(File sample code for java.io.File definition code for java.io.File  file,
               boolean verify)
        throws IOException sample code for java.io.IOException definition code for java.io.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 jar file if it is signed.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error has occurred
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if access to the file is denied by the SecurityManager.

JarFile sample code for java.util.jar.JarFile(java.io.File, boolean, int) definition code for java.util.jar.JarFile(java.io.File, boolean, int) 

public JarFile(File sample code for java.io.File definition code for java.io.File  file,
               boolean verify,
               int mode)
        throws IOException sample code for java.io.IOException definition code for java.io.IOException
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 - the jar file to be opened for reading
verify - whether or not to verify the jar file if it is signed.
mode - the mode in which the file is to be opened
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error has occurred
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the mode argument is invalid
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if access to the file is denied by the SecurityManager
Method Detail

getManifest sample code for java.util.jar.JarFile.getManifest() definition code for java.util.jar.JarFile.getManifest() 

public Manifest sample code for java.util.jar.Manifest definition code for java.util.jar.Manifest  getManifest()
                     throws IOException sample code for java.io.IOException definition code for java.io.IOException
Returns the jar file manifest, or null if none.

Returns:
the jar file manifest, or null if none
Throws:
IllegalStateException sample code for java.lang.IllegalStateException definition code for java.lang.IllegalStateException - may be thrown if the jar file has been closed
IOException sample code for java.io.IOException definition code for java.io.IOException

getJarEntry sample code for java.util.jar.JarFile.getJarEntry(java.lang.String) definition code for java.util.jar.JarFile.getJarEntry(java.lang.String) 

public JarEntry sample code for java.util.jar.JarEntry definition code for java.util.jar.JarEntry  getJarEntry(String sample code for java.lang.String definition code for java.lang.String  name)
Returns the JarEntry for the given entry name or null if not found.

Parameters:
name - the jar file entry name
Retur