java.util.jar

Class JarFile

java.lang.Object

java.util.zip.ZipFile

java.util.jar.JarFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class JarFile
extends ZipFile

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

See Also:

JarInputStream, JarEntry

Nested Class Summary

Nested classes/interfaces inherited from class java.util.zip.ZipFile

ZipFile.RAFStream, ZipFile.ZipInflaterInputStream

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER
static String	MANIFEST_NAME The MANIFEST file name.

Fields inherited from class java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

Constructor Summary

Constructors

Constructor and Description
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.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.util.zip.ZipFile

finalize, getComment, getName, size

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MANIFEST_NAME

public static final String MANIFEST_NAME

The MANIFEST file name.

See Also:

Constant Field Values

LOCSIG

public static final long LOCSIG

See Also:

Constant Field Values

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

See Also:

Constant Field Values

LOCVER

public static final int LOCVER

See Also:

Constant Field Values

LOCFLG

public static final int LOCFLG

See Also:

Constant Field Values

LOCHOW

public static final int LOCHOW

See Also:

Constant Field Values

LOCTIM

public static final int LOCTIM

See Also:

Constant Field Values

LOCCRC

public static final int LOCCRC

See Also:

Constant Field Values

LOCSIZ

public static final int LOCSIZ

See Also:

Constant Field Values

LOCLEN

public static final int LOCLEN

See Also:

Constant Field Values

LOCNAM

public static final int LOCNAM

See Also:

Constant Field Values

LOCEXT

public static final int LOCEXT

See Also:

Constant Field Values

EXTCRC

public static final int EXTCRC

See Also:

Constant Field Values

EXTSIZ

public static final int EXTSIZ

See Also:

Constant Field Values

EXTLEN

public static final int EXTLEN

See Also:

Constant Field Values

CENVEM

public static final int CENVEM

See Also:

Constant Field Values

CENVER

public static final int CENVER

See Also:

Constant Field Values

CENFLG

public static final int CENFLG

See Also:

Constant Field Values

CENHOW

public static final int CENHOW

See Also:

Constant Field Values

CENTIM

public static final int CENTIM

See Also:

Constant Field Values

CENCRC

public static final int CENCRC

See Also:

Constant Field Values

CENSIZ

public static final int CENSIZ

See Also:

Constant Field Values

CENLEN

public static final int CENLEN

See Also:

Constant Field Values

CENNAM

public static final int CENNAM

See Also:

Constant Field Values

CENEXT

public static final int CENEXT

See Also:

Constant Field Values

CENCOM

public static final int CENCOM

See Also:

Constant Field Values

CENDSK

public static final int CENDSK

See Also:

Constant Field Values

CENATT

public static final int CENATT

See Also:

Constant Field Values

CENATX

public static final int CENATX

See Also:

Constant Field Values

CENOFF

public static final int CENOFF

See Also:

Constant Field Values

ENDSUB

public static final int ENDSUB

See Also:

Constant Field Values

ENDTOT

public static final int ENDTOT

See Also:

Constant Field Values

ENDSIZ

public static final int ENDSIZ

See Also:

Constant Field Values

ENDOFF

public static final int ENDOFF

See Also:

Constant Field Values

ENDCOM

public static final int ENDCOM

See Also:

Constant Field Values

Constructor Detail

JarFile

public JarFile(File file)
        throws IOException

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.

JarFile

public JarFile(File file,
               boolean verify)
        throws IOException

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.

JarFile

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

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.

JarFile

public JarFile(String filename)
        throws IOException

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.

JarFile

public JarFile(String filename,
               boolean verify)
        throws IOException

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.

Method Detail

entries

public Enumeration<JarEntry> entries()

Return an enumeration containing the JarEntrys contained in this JarFile.

Overrides:

entries in class ZipFile

Returns:

the Enumeration containing the JAR entries.

Throws:

IllegalStateException - if this JarFile is closed.

getJarEntry

public JarEntry getJarEntry(String name)

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.

getManifest

public Manifest getManifest()
                     throws IOException

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.

See Also:

Manifest

getInputStream

public InputStream getInputStream(ZipEntry ze)
                           throws IOException

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

Overrides:

getInputStream in class ZipFile

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.

getEntry

public ZipEntry getEntry(String name)

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

Overrides:

getEntry in class ZipFile

Parameters:

name - the name of the entry in the JAR file.

Returns:

the ZIP entry extracted.

close

public void close()
           throws IOException

Closes this JarFile.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class ZipFile

Throws:

IOException - if an error occurs.