Class ZipFile

public static final int OPEN_DELETE

Mode flag to delete a zip file after reading.

Field Value:

4

public static final int OPEN_READ

Mode flag to open a zip file for reading.

Field Value:

1

public ZipFile(File file)
            throws ZipException,
                   IOException

Opens a Zip file reading the given File.

Throws:

IOException - if a i/o error occured.

ZipException - if the file doesn't contain a valid zip archive.

public ZipFile(File file,
               int mode)
            throws ZipException,
                   IOException

Opens a Zip file reading the given File in the given mode. If the OPEN_DELETE mode is specified, the zip file will be deleted at some time moment after it is opened. It will be deleted before the zip file is closed or the Virtual Machine exits. The contents of the zip file will be accessible until it is closed.

Parameters:

mode - Must be one of OPEN_READ or OPEN_READ | OPEN_DELETE

Throws:

IOException - if a i/o error occured.

ZipException - if the file doesn't contain a valid zip archive.

Since:

JDK1.3

public ZipFile(String name)
            throws ZipException,
                   IOException

Opens a Zip file with the given name for reading.

Throws:

IOException - if a i/o error occured.

ZipException - if the file doesn't contain a valid zip archive.

public void close()
            throws IOException

Closes the ZipFile. This also closes all input streams given by this class. After this is called, no further method should be called.

Throws:

IOException - if a i/o error occured.

public Enumerationextends ZipEntry> entries()

Returns an enumeration of all Zip entries in this Zip file.

Throws:

IllegalStateException - when the ZipFile has already been closed

protected void finalize()
            throws IOException

Calls the close() method when this ZipFile has not yet been explicitly closed.

Overrides:

finalize in interface Object

public ZipEntry getEntry(String name)

Searches for a zip entry in this archive with the given name.

Parameters:

name - the name. May contain directory components separated by slashes ('/').

Returns:

the zip entry, or null if no entry with that name exists.

Throws:

IllegalStateException - when the ZipFile has already been closed

public InputStream getInputStream(ZipEntry entry)
            throws IOException

Creates an input stream reading the given zip entry as uncompressed data. Normally zip entry should be an entry returned by getEntry() or entries(). This implementation returns null if the requested entry does not exist. This decision is not obviously correct, however, it does appear to mirror Sun's implementation, and it is consistant with their javadoc. On the other hand, the old JCL book, 2nd Edition, claims that this should return a "non-null ZIP entry". We have chosen for now ignore the old book, as modern versions of Ant (an important application) depend on this behaviour. See discussion in this thread: http://gcc.gnu.org/ml/java-patches/2004-q2/msg00602.html

Parameters:

entry - the entry to create an InputStream for.

Returns:

the input stream, or null if the requested entry does not exist.

Throws:

IllegalStateException - when the ZipFile has already been closed

IOException - if a i/o error occured.

public String getName()

Returns the (path) name of this zip file.

public int size()

Returns the number of entries in this zip file.

Throws:

IllegalStateException - when the ZipFile has already been closed