java.lang.Object | |
↳ | java.util.zip.ZipFile |
Known Direct Subclasses |
This class provides random read access to a ZIP-archive file.
While ZipInputStream
provides stream based read access to a
ZIP-archive, this class implements more efficient (file based) access
and makes use of the central directory within a ZIP-archive.
Use ZipOutputStream
if you want to create an archive.
A temporary ZIP file can be marked for automatic deletion upon closing it.
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 | Delete ZIP file when closed. | |||||||||
int | OPEN_READ | Open ZIP file for read. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new
ZipFile with the specified file. | |||||||||||
Opens a file as ZIP-archive.
| |||||||||||
Opens a ZIP archived file.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Closes this ZIP file.
| |||||||||||
Returns an enumeration of the entries.
| |||||||||||
Gets the ZIP entry with the specified name from this
ZipFile . | |||||||||||
Returns an input stream on the data of the specified
ZipEntry . | |||||||||||
Gets the file name of this
ZipFile . | |||||||||||
Returns the number of
ZipEntries in this ZipFile . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Delete ZIP file when closed.
Open ZIP file for read.
Constructs a new ZipFile
with the specified file.
file | the file to read from. |
---|
ZipException | if a ZIP error occurs. |
---|---|
IOException | if an IOException occurs.
|
Opens a file as ZIP-archive. "mode" must be OPEN_READ
or
OPEN_DELETE
. The latter sets the "delete on exit" flag through a
file.
file | the ZIP file to read. |
---|---|
mode | the mode of the file open operation. |
IOException | if an IOException occurs.
|
---|
Opens a ZIP archived file.
name | the name of the ZIP file. |
---|
IOException | if an IOException occurs. |
---|
Closes this ZIP file. This method is idempotent.
IOException | if an IOException occurs. |
---|
Returns an enumeration of the entries. The entries are listed in the order in which they appear in the ZIP archive.
IllegalStateException | if this ZIP file has been closed. |
---|
Gets the ZIP entry with the specified name from this ZipFile
.
entryName | the name of the entry in the ZIP file. |
---|
ZipEntry
or null
if the entry name does not
exist in the ZIP file.IllegalStateException | if this ZIP file has been closed. |
---|
Returns an input stream on the data of the specified ZipEntry
.
entry | the ZipEntry. |
---|
ZipEntry
.IOException | if an IOException occurs. |
---|---|
IllegalStateException | if this ZIP file has been closed. |
Gets the file name of this ZipFile
.
ZipFile
.
Returns the number of ZipEntries
in this ZipFile
.
IllegalStateException | if this ZIP file has been closed. |
---|
Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
Note that objects that override finalize
are significantly more expensive than
objects that don't. Finalizers may be run a long time after the object is no longer
reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup.
Note also that finalizers are run on a single VM-wide finalizer thread,
so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary
for a class that has a native peer and needs to call a native method to destroy that peer.
Even then, it's better to provide an explicit close
method (and implement
Closeable
), and insist that callers manually dispose of instances. This
works well for something like files, but less well for something like a BigInteger
where typical calling code would have to deal with lots of temporaries. Unfortunately,
code that creates lots of temporaries is the worst kind of code from the point of view of
the single finalizer thread.
If you must use finalizers, consider at least providing your own
ReferenceQueue
and having your own thread process that queue.
Unlike constructors, finalizers are not automatically chained. You are responsible for
calling super.finalize()
yourself.
Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
IOException |
---|