java.util.zip
Class ZipFile

java.lang.Object
  extended by java.util.zip.ZipFile
Direct Known Subclasses:
JarFile

public class ZipFile
extends Object

This class represents a Zip archive. You can ask for the contained entries, or get an input stream for a file entry. The entry is automatically decompressed. This class is thread safe: You can open input streams for arbitrary entries in different threads.


Field Summary
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 int OPEN_DELETE
          Mode flag to delete a zip file after reading.
static int OPEN_READ
          Mode flag to open a zip file for reading.
 
Constructor Summary
ZipFile(File file)
          Opens a Zip file reading the given File.
ZipFile(File file, int mode)
          Opens a Zip file reading the given File in the given mode.
ZipFile(String name)
          Opens a Zip file with the given name for reading.
 
Method Summary
 void close()
          Closes the ZipFile.
 Enumeration<? extends ZipEntry> entries()
          Returns an enumeration of all Zip entries in this Zip file.
protected  void finalize()
          Calls the close() method when this ZipFile has not yet been explicitly closed.
 ZipEntry getEntry(String name)
          Searches for a zip entry in this archive with the given name.
 InputStream getInputStream(ZipEntry entry)
          Creates an input stream reading the given zip entry as uncompressed data.
 String getName()
          Returns the (path) name of this zip file.
 int size()
          Returns the number of entries in this zip file.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPEN_READ

public static final int OPEN_READ
Mode flag to open a zip file for reading.

See Also:
Constant Field Values

OPEN_DELETE

public static final int OPEN_DELETE
Mode flag to delete a zip file after reading.

See Also:
Constant Field Values

LOCHDR

public static final int LOCHDR
See Also:
Constant Field Values

LOCSIG

public static final long LOCSIG
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

EXTSIG

public static final long EXTSIG
See Also:
Constant Field Values

EXTHDR

public static final int EXTHDR
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

CENSIG

public static final long CENSIG
See Also:
Constant Field Values

CENHDR

public static final int CENHDR
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

ENDSIG

public static final long ENDSIG
See Also:
Constant Field Values

ENDHDR

public static final int ENDHDR
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

ZipFile

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.

ZipFile

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.

ZipFile

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
Method Detail

close

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.

finalize

protected void finalize()
                 throws IOException
Calls the close() method when this ZipFile has not yet been explicitly closed.

Overrides:
finalize in class Object
Throws:
IOException
See Also:
System.gc(), System.runFinalizersOnExit(boolean), java.lang.ref

entries

public Enumeration<? extends ZipEntry> entries()
Returns an enumeration of all Zip entries in this Zip file.

Throws:
IllegalStateException - when the ZipFile has already been closed

getEntry

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

getInputStream

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.
ZipException - if the Zip archive is malformed.

getName

public String getName()
Returns the (path) name of this zip file.


size

public int size()
Returns the number of entries in this zip file.

Throws:
IllegalStateException - when the ZipFile has already been closed