| java.lang.Object | |
| ↳ | java.util.zip.ZipFile |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
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.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Opens a zip file for reading.
| |||||||||||
Opens a new
ZipFile to read from the specified
File object in the specified mode. | |||||||||||
Opens a ZIP file for reading given the specified File object.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Closes the ZIP file.
| |||||||||||
Returns an enumeration of the ZIP file entries.
| |||||||||||
Returns the zip file entry for the specified name, or null
if not found.
| |||||||||||
Returns an input stream for reading the contents of the specified
zip file entry.
| |||||||||||
Returns the path name of the ZIP file.
| |||||||||||
Returns the number of entries in the ZIP file.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Ensures that the
close method of this ZIP file is
called when there are no more references to it. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Constants
public static final int CENATT
public static final int CENATX
public static final int CENCOM
public static final int CENCRC
public static final int CENDSK
public static final int CENEXT
public static final int CENFLG
public static final int CENHDR
public static final int CENHOW
public static final int CENLEN
public static final int CENNAM
public static final int CENOFF
public static final long CENSIG
public static final int CENSIZ
public static final int CENTIM
public static final int CENVEM
public static final int CENVER
public static final int ENDCOM
public static final int ENDHDR
public static final int ENDOFF
public static final long ENDSIG
public static final int ENDSIZ
public static final int ENDSUB
public static final int ENDTOT
public static final int EXTCRC
public static final int EXTHDR
public static final int EXTLEN
public static final long EXTSIG
public static final int EXTSIZ
public static final int LOCCRC
public static final int LOCEXT
public static final int LOCFLG
public static final int LOCHDR
public static final int LOCHOW
public static final int LOCLEN
public static final int LOCNAM
public static final long LOCSIG
public static final int LOCSIZ
public static final int LOCTIM
public static final int LOCVER
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.
public static final int OPEN_READ
Mode flag to open a zip file for reading.
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.
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. |
See Also
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.
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 |
See Also
public ZipFile (File file)
Opens a ZIP file for reading given the specified File object.
Parameters
| file | the ZIP file to be opened for reading |
|---|
Throws
| ZipException | if a ZIP 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 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 close method of this ZIP file is
called 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 |
|---|