Class ZipFile
java.lang.Object
java.util.zip.ZipFile
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
JarFile
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.
- API Note:
- To release resources used by this
ZipFile
, theclose()
method should be called explicitly or by try-with-resources. Subclasses are responsible for the cleanup of resources acquired by the subclass. Subclasses that overrideObject.finalize()
in order to perform cleanup should be modified to use alternative cleanup mechanisms such asCleaner
and remove the overridingfinalize
method. - Since:
- 1.1
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Central directory (CEN) header internal file attributes field offset.static final int
Central directory (CEN) header external file attributes field offset.static final int
Central directory (CEN) header comment length field offset.static final int
Central directory (CEN) header uncompressed file crc-32 value field offset.static final int
Central directory (CEN) header disk number start field offset.static final int
Central directory (CEN) header extra field length field offset.static final int
Central directory (CEN) header encrypt, decrypt flags field offset.static final int
Central directory (CEN) header size in bytes (including signature).static final int
Central directory (CEN) header compression method field offset.static final int
Central directory (CEN) header uncompressed size field offset.static final int
Central directory (CEN) header filename length field offset.static final int
Central directory (CEN) header LOC header offset field offset.static final long
Central directory (CEN) header signature.static final int
Central directory (CEN) header compressed size field offset.static final int
Central directory (CEN) header modification time field offset.static final int
Central directory (CEN) header version made by field offset.static final int
Central directory (CEN) header version needed to extract field offset.static final int
End of central directory (END) header ZIP file comment length field offset.static final int
End of central directory (END) header size in bytes (including signature).static final int
End of central directory (END) header offset for the first CEN header field offset.static final long
End of central directory (END) header signature.static final int
End of central directory (END) header central directory size in bytes field offset.static final int
End of central directory (END) header number of entries on this disk field offset.static final int
End of central directory (END) header total number of entries field offset.static final int
Extra local (EXT) header uncompressed file crc-32 value field offset.static final int
Extra local (EXT) header size in bytes (including signature).static final int
Extra local (EXT) header uncompressed size field offset.static final long
Extra local (EXT) header signature.static final int
Extra local (EXT) header compressed size field offset.static final int
Local file (LOC) header uncompressed file crc-32 value field offset.static final int
Local file (LOC) header extra field length field offset.static final int
Local file (LOC) header general purpose bit flag field offset.static final int
Local file (LOC) header size in bytes (including signature).static final int
Local file (LOC) header compression method field offset.static final int
Local file (LOC) header uncompressed size field offset.static final int
Local file (LOC) header filename length field offset.static final long
Local file (LOC) header signature.static final int
Local file (LOC) header compressed size field offset.static final int
Local file (LOC) header modification time field offset.static final int
Local file (LOC) header version needed to extract field offset.static final int
Mode flag to open a ZIP file and mark it for deletion.static final int
Mode flag to open a ZIP file for reading. -
Constructor Summary
ConstructorDescriptionOpens a ZIP file for reading given the specified File object.Opens a newZipFile
to read from the specifiedFile
object in the specified mode.Opens a newZipFile
to read from the specifiedFile
object in the specified mode.Opens a ZIP file for reading given the specified File object.Opens a ZIP file for reading.Opens a ZIP file for reading. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the ZIP file.Enumeration
<? extends ZipEntry> entries()
Returns an enumeration of the ZIP file entries.Returns the ZIP file comment.Returns the ZIP file entry for the specified name, or null if not found.getInputStream
(ZipEntry entry) Returns an input stream for reading the contents of the specified ZIP file entry.getName()
Returns the path name of the ZIP file.int
size()
Returns the number of entries in the ZIP file.stream()
Returns an orderedStream
over the ZIP file entries.toString()
Returns a string identifying thisZipFile
, for debugging.
-
Field Details
-
OPEN_READ
public static final int OPEN_READMode flag to open a ZIP file for reading.- See Also:
-
OPEN_DELETE
public static final int OPEN_DELETEMode 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 theZipFile
object until either the close method is invoked or the virtual machine exits.- See Also:
-
LOCSIG
static final long LOCSIGLocal file (LOC) header signature.- See Also:
-
EXTSIG
static final long EXTSIGExtra local (EXT) header signature.- See Also:
-
CENSIG
static final long CENSIGCentral directory (CEN) header signature.- See Also:
-
ENDSIG
static final long ENDSIGEnd of central directory (END) header signature.- See Also:
-
LOCHDR
static final int LOCHDRLocal file (LOC) header size in bytes (including signature).- See Also:
-
EXTHDR
static final int EXTHDRExtra local (EXT) header size in bytes (including signature).- See Also:
-
CENHDR
static final int CENHDRCentral directory (CEN) header size in bytes (including signature).- See Also:
-
ENDHDR
static final int ENDHDREnd of central directory (END) header size in bytes (including signature).- See Also:
-
LOCVER
static final int LOCVERLocal file (LOC) header version needed to extract field offset.- See Also:
-
LOCFLG
static final int LOCFLGLocal file (LOC) header general purpose bit flag field offset.- See Also:
-
LOCHOW
static final int LOCHOWLocal file (LOC) header compression method field offset.- See Also:
-
LOCTIM
static final int LOCTIMLocal file (LOC) header modification time field offset.- See Also:
-
LOCCRC
static final int LOCCRCLocal file (LOC) header uncompressed file crc-32 value field offset.- See Also:
-
LOCSIZ
static final int LOCSIZLocal file (LOC) header compressed size field offset.- See Also:
-
LOCLEN
static final int LOCLENLocal file (LOC) header uncompressed size field offset.- See Also:
-
LOCNAM
static final int LOCNAMLocal file (LOC) header filename length field offset.- See Also:
-
LOCEXT
static final int LOCEXTLocal file (LOC) header extra field length field offset.- See Also:
-
EXTCRC
static final int EXTCRCExtra local (EXT) header uncompressed file crc-32 value field offset.- See Also:
-
EXTSIZ
static final int EXTSIZExtra local (EXT) header compressed size field offset.- See Also:
-
EXTLEN
static final int EXTLENExtra local (EXT) header uncompressed size field offset.- See Also:
-
CENVEM
static final int CENVEMCentral directory (CEN) header version made by field offset.- See Also:
-
CENVER
static final int CENVERCentral directory (CEN) header version needed to extract field offset.- See Also:
-
CENFLG
static final int CENFLGCentral directory (CEN) header encrypt, decrypt flags field offset.- See Also:
-
CENHOW
static final int CENHOWCentral directory (CEN) header compression method field offset.- See Also:
-
CENTIM
static final int CENTIMCentral directory (CEN) header modification time field offset.- See Also:
-
CENCRC
static final int CENCRCCentral directory (CEN) header uncompressed file crc-32 value field offset.- See Also:
-
CENSIZ
static final int CENSIZCentral directory (CEN) header compressed size field offset.- See Also:
-
CENLEN
static final int CENLENCentral directory (CEN) header uncompressed size field offset.- See Also:
-
CENNAM
static final int CENNAMCentral directory (CEN) header filename length field offset.- See Also:
-
CENEXT
static final int CENEXTCentral directory (CEN) header extra field length field offset.- See Also:
-
CENCOM
static final int CENCOMCentral directory (CEN) header comment length field offset.- See Also:
-
CENDSK
static final int CENDSKCentral directory (CEN) header disk number start field offset.- See Also:
-
CENATT
static final int CENATTCentral directory (CEN) header internal file attributes field offset.- See Also:
-
CENATX
static final int CENATXCentral directory (CEN) header external file attributes field offset.- See Also:
-
CENOFF
static final int CENOFFCentral directory (CEN) header LOC header offset field offset.- See Also:
-
ENDSUB
static final int ENDSUBEnd of central directory (END) header number of entries on this disk field offset.- See Also:
-
ENDTOT
static final int ENDTOTEnd of central directory (END) header total number of entries field offset.- See Also:
-
ENDSIZ
static final int ENDSIZEnd of central directory (END) header central directory size in bytes field offset.- See Also:
-
ENDOFF
static final int ENDOFFEnd of central directory (END) header offset for the first CEN header field offset.- See Also:
-
ENDCOM
static final int ENDCOMEnd of central directory (END) header ZIP file comment length field offset.- See Also:
-
-
Constructor Details
-
ZipFile
Opens a ZIP file for reading.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 occurredIOException
- if an I/O error has occurred
-
ZipFile
Opens a newZipFile
to read from the specifiedFile
object in the specified mode. The mode argument must be eitherOPEN_READ
orOPEN_READ | OPEN_DELETE
.The UTF-8
charset
is used to decode the entry names and comments- Parameters:
file
- the ZIP file to be opened for readingmode
- the mode in which the file is to be opened- Throws:
ZipException
- if a ZIP format error has occurredIOException
- if an I/O error has occurredIllegalArgumentException
- if themode
argument is invalid- Since:
- 1.3
-
ZipFile
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 occurredIOException
- if an I/O error has occurred
-
ZipFile
Opens a newZipFile
to read from the specifiedFile
object in the specified mode. The mode argument must be eitherOPEN_READ
orOPEN_READ | OPEN_DELETE
.- Parameters:
file
- the ZIP file to be opened for readingmode
- the mode in which the file is to be openedcharset
- the 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 occurredIOException
- if an I/O error has occurredIllegalArgumentException
- if themode
argument is invalid- Since:
- 1.7
-
ZipFile
Opens a ZIP file for reading.- Parameters:
name
- the name of the ZIP filecharset
- the 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 occurredIOException
- if an I/O error has occurred- Since:
- 1.7
-
ZipFile
Opens a ZIP file for reading given the specified File object.- Parameters:
file
- the ZIP file to be opened for readingcharset
- The 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 occurredIOException
- if an I/O error has occurred- Since:
- 1.7
-
-
Method Details
-
getComment
Returns the ZIP file comment. If a comment does not exist or an error is encountered decoding the comment using the charset specified when opening the ZIP file, thennull
is returned.- Returns:
- the comment string for the ZIP file, or null if none
- Throws:
IllegalStateException
- if the ZIP file has been closed- Since:
- 1.7
-
getEntry
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
-
getInputStream
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.
- API Note:
- The
InputStream
returned by this method can wrap anInflaterInputStream
, whoseread(byte[], int, int)
method can modify any element of the output buffer. - Parameters:
entry
- the ZIP file entry- Returns:
- the input stream for reading the contents of the specified ZIP file entry or null if the ZIP file entry does not exist within the ZIP file.
- Throws:
ZipException
- if a ZIP format error has occurredIOException
- if an I/O error has occurredIllegalStateException
- if the ZIP file has been closed
-
getName
Returns the path name of the ZIP file.- Returns:
- the path name of the ZIP file
-
toString
-
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
-
stream
Returns an orderedStream
over the ZIP file entries. Entries appear in theStream
in the order they appear in the central directory of the ZIP file.- Returns:
- an ordered
Stream
of entries in this ZIP file - Throws:
IllegalStateException
- if the ZIP file has been closed- Since:
- 1.8
-
size
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
-
close
Closes the ZIP file.Closing this ZIP file will close all of the input streams previously returned by invocations of the
getInputStream
method.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- if an I/O error has occurred
-