ZipFile

public class ZipFile extends Object
implements Closeable
Known Direct Subclasses

This class is used to read entries from a zip file.

Unless otherwise noted, passing a null argument to a constructor or method in this class will cause a NullPointerException to be thrown.

Constant Summary

int CENATT
int CENATX
int CENCOM
int CENCRC
int CENDSK
int CENEXT
int CENFLG
int CENHDR
int CENHOW
int CENLEN
int CENNAM
int CENOFF
long CENSIG
int CENSIZ
int CENTIM
int CENVEM
int CENVER
int ENDCOM
int ENDHDR
int ENDOFF
long ENDSIG
int ENDSIZ
int ENDSUB
int ENDTOT
int EXTCRC
int EXTHDR
int EXTLEN
long EXTSIG
int EXTSIZ
int LOCCRC
int LOCEXT
int LOCFLG
int LOCHDR
int LOCHOW
int LOCLEN
int LOCNAM
long LOCSIG
int LOCSIZ
int LOCTIM
int LOCVER
int OPEN_DELETE Mode flag to open a zip file and mark it for deletion.
int OPEN_READ Mode flag to open a zip file for reading.

Public Constructor Summary

ZipFile(String name)
Opens a zip file for reading.
ZipFile(File file, int mode)
Opens a new ZipFile to read from the specified File object in the specified mode.
ZipFile(File file)
Opens a ZIP file for reading given the specified File object.
ZipFile(File file, int mode, Charset charset)
Opens a new ZipFile to read from the specified File object in the specified mode.
ZipFile(String name, Charset charset)
Opens a zip file for reading.
ZipFile(File file, Charset charset)
Opens a ZIP file for reading given the specified File object.

Public Method Summary

void
close()
Closes the ZIP file.
Enumeration<? extends ZipEntry>
entries()
Returns an enumeration of the ZIP file entries.
String
getComment()
Returns the zip file comment, or null if none.
ZipEntry
getEntry(String name)
Returns the zip file entry for the specified name, or null if not found.
InputStream
getInputStream(ZipEntry entry)
Returns an input stream for reading the contents of the specified zip file entry.
String
getName()
Returns the path name of the ZIP file.
int
size()
Returns the number of entries in the ZIP file.

Protected Method Summary

void
finalize()
Ensures that the system resources held by this ZipFile object are released when there are no more references to it.

Inherited Method Summary

Constants

public static final int CENATT

Constant Value: 36

public static final int CENATX

Constant Value: 38

public static final int CENCOM

Constant Value: 32

public static final int CENCRC

Constant Value: 16

public static final int CENDSK

Constant Value: 34

public static final int CENEXT

Constant Value: 30

public static final int CENFLG

Constant Value: 8

public static final int CENHDR

Constant Value: 46

public static final int CENHOW

Constant Value: 10

public static final int CENLEN

Constant Value: 24

public static final int CENNAM

Constant Value: 28

public static final int CENOFF

Constant Value: 42

public static final long CENSIG

Constant Value: 33639248

public static final int CENSIZ

Constant Value: 20

public static final int CENTIM

Constant Value: 12

public static final int CENVEM

Constant Value: 4

public static final int CENVER

Constant Value: 6

public static final int ENDCOM

Constant Value: 20

public static final int ENDHDR

Constant Value: 22

public static final int ENDOFF

Constant Value: 16

public static final long ENDSIG

Constant Value: 101010256

public static final int ENDSIZ

Constant Value: 12

public static final int ENDSUB

Constant Value: 8

public static final int ENDTOT

Constant Value: 10

public static final int EXTCRC

Constant Value: 4

public static final int EXTHDR

Constant Value: 16

public static final int EXTLEN

Constant Value: 12

public static final long EXTSIG

Constant Value: 134695760

public static final int EXTSIZ

Constant Value: 8

public static final int LOCCRC

Constant Value: 14

public static final int LOCEXT

Constant Value: 28

public static final int LOCFLG

Constant Value: 6

public static final int LOCHDR

Constant Value: 30

public static final int LOCHOW

Constant Value: 8

public static final int LOCLEN

Constant Value: 22

public static final int LOCNAM

Constant Value: 26

public static final long LOCSIG

Constant Value: 67324752

public static final int LOCSIZ

Constant Value: 18

public static final int LOCTIM

Constant Value: 10

public static final int LOCVER

Constant Value: 4

public static final int OPEN_DELETE

Mode flag to open a zip file and mark it for deletion. The file will be deleted some time between the moment that it is opened and the moment that it is closed, but its contents will remain accessible via the ZipFile object until either the close method is invoked or the virtual machine exits.

Constant Value: 4

public static final int OPEN_READ

Mode flag to open a zip file for reading.

Constant Value: 1

Public Constructors

public ZipFile (String name)

Opens a zip file for reading.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

The UTF-8 charset is used to decode the entry names and comments.

Parameters
name the name of the zip file
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred
SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file.

public ZipFile (File file, int mode)

Opens a new ZipFile to read from the specified File object in the specified mode. The mode argument must be either OPEN_READ or OPEN_READ | OPEN_DELETE.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

The UTF-8 charset is used to decode the entry names and comments

Parameters
file the ZIP file to be opened for reading
mode the mode in which the file is to be opened
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred
SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file, or its checkDelete method doesn't allow deleting the file when the OPEN_DELETE flag is set.
IllegalArgumentException if the mode argument is invalid

public ZipFile (File file)

Opens a ZIP file for reading given the specified File object.

The UTF-8 charset is used to decode the entry names and comments.

Parameters
file the ZIP file to be opened for reading
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred

public ZipFile (File file, int mode, Charset charset)

Opens a new ZipFile to read from the specified File object in the specified mode. The mode argument must be either OPEN_READ or OPEN_READ | OPEN_DELETE.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

Parameters
file the ZIP file to be opened for reading
mode the mode in which the file is to be opened
charset the {@linkplain java.nio.charset.Charset charset} to be used to decode the ZIP entry name and comment that are not encoded by using UTF-8 encoding (indicated by entry's general purpose flag).
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred
SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file,or its checkDelete method doesn't allow deleting the file when the OPEN_DELETE flag is set
IllegalArgumentException if the mode argument is invalid

public ZipFile (String name, Charset charset)

Opens a zip file for reading.

First, if there is a security manager, its checkRead method is called with the name argument as its argument to ensure the read is allowed.

Parameters
name the name of the zip file
charset the {@linkplain java.nio.charset.Charset charset} to be used to decode the ZIP entry name and comment that are not encoded by using UTF-8 encoding (indicated by entry's general purpose flag).
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred
SecurityException if a security manager exists and its checkRead method doesn't allow read access to the file

public ZipFile (File file, Charset charset)

Opens a ZIP file for reading given the specified File object.

Parameters
file the ZIP file to be opened for reading
charset The {@linkplain java.nio.charset.Charset charset} to be used to decode the ZIP entry name and comment (ignored if the language encoding bit of the ZIP entry's general purpose bit flag is set).
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred

Public Methods

public void close ()

Closes the ZIP file.

Closing this ZIP file will close all of the input streams previously returned by invocations of the getInputStream method.

Throws
IOException if an I/O error has occurred

public Enumeration<? extends ZipEntry> entries ()

Returns an enumeration of the ZIP file entries.

Returns
  • an enumeration of the ZIP file entries
Throws
IllegalStateException if the zip file has been closed

public String getComment ()

Returns the zip file comment, or null if none.

Returns
  • the comment string for the zip file, or null if none
Throws
IllegalStateException if the zip file has been closed Since 1.7

public ZipEntry getEntry (String name)

Returns the zip file entry for the specified name, or null if not found.

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

public InputStream getInputStream (ZipEntry entry)

Returns an input stream for reading the contents of the specified zip file entry.

Closing this ZIP file will, in turn, close all input streams that have been returned by invocations of this method.

Parameters
entry the zip file entry
Returns
  • the input stream for reading the contents of the specified zip file entry.
Throws
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred
IllegalStateException if the zip file has been closed

public String getName ()

Returns the path name of the ZIP file.

Returns
  • the path name of the ZIP file

public int size ()

Returns the number of entries in the ZIP file.

Returns
  • the number of entries in the ZIP file
Throws
IllegalStateException if the zip file has been closed

Protected Methods

protected void finalize ()

Ensures that the system resources held by this ZipFile object are released when there are no more references to it.

Since the time when GC would invoke this method is undetermined, it is strongly recommended that applications invoke the close method as soon they have finished accessing this ZipFile. This will prevent holding up system resources for an undetermined length of time.

Throws
IOException if an I/O error has occurred
See Also