- java.lang.Object
- 
- java.util.zip.ZipFile
 
- 
- All Implemented Interfaces:
- Closeable,- AutoCloseable
 - Direct Known Subclasses:
- JarFile
 
 public class ZipFile extends Object implements Closeable This class is used to read entries from a zip file.Unless otherwise noted, passing a nullargument to a constructor or method in this class will cause aNullPointerExceptionto 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 overridefinalize()in order to perform cleanup should be modified to use alternative cleanup mechanisms such asCleanerand remove the overridingfinalizemethod.
- Implementation Requirements:
- If this ZipFilehas been subclassed and theclosemethod has been overridden, theclosemethod will be called by the finalization whenZipFileis unreachable. But the subclasses should not depend on this specific implementation; the finalization is not reliable and thefinalizemethod is deprecated to be removed.
- Since:
- 1.1
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intCENATTstatic intCENATXstatic intCENCOMstatic intCENCRCstatic intCENDSKstatic intCENEXTstatic intCENFLGstatic intCENHDRstatic intCENHOWstatic intCENLENstatic intCENNAMstatic intCENOFFstatic longCENSIGstatic intCENSIZstatic intCENTIMstatic intCENVEMstatic intCENVERstatic intENDCOMstatic intENDHDRstatic intENDOFFstatic longENDSIGstatic intENDSIZstatic intENDSUBstatic intENDTOTstatic intEXTCRCstatic intEXTHDRstatic intEXTLENstatic longEXTSIGstatic intEXTSIZstatic intLOCCRCstatic intLOCEXTstatic intLOCFLGstatic intLOCHDRstatic intLOCHOWstatic intLOCLENstatic intLOCNAMstatic longLOCSIGstatic intLOCSIZstatic intLOCTIMstatic intLOCVERstatic intOPEN_DELETEMode flag to open a zip file and mark it for deletion.static intOPEN_READMode flag to open a zip file for reading.
 - 
Constructor SummaryConstructors Constructor Description ZipFile(File file)Opens a ZIP file for reading given the specified File object.ZipFile(File file, int mode)Opens a newZipFileto read from the specifiedFileobject in the specified mode.ZipFile(File file, int mode, Charset charset)Opens a newZipFileto read from the specifiedFileobject in the specified mode.ZipFile(File file, Charset charset)Opens a ZIP file for reading given the specified File object.ZipFile(String name)Opens a zip file for reading.ZipFile(String name, Charset charset)Opens a zip file for reading.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidclose()Closes the ZIP file.Enumeration<? extends ZipEntry>entries()Returns an enumeration of the ZIP file entries.protected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Thefinalizemethod has been deprecated and will be removed.StringgetComment()Returns the zip file comment, or null if none.ZipEntrygetEntry(String name)Returns the zip file entry for the specified name, or null if not found.InputStreamgetInputStream(ZipEntry entry)Returns an input stream for reading the contents of the specified zip file entry.StringgetName()Returns the path name of the ZIP file.intsize()Returns the number of entries in the ZIP file.Stream<? extends ZipEntry>stream()Returns an orderedStreamover the ZIP file entries.
 
- 
- 
- 
Field Detail- 
OPEN_READpublic static final int OPEN_READ Mode flag to open a zip file for reading.- See Also:
- Constant Field Values
 
 - 
OPEN_DELETEpublic 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 theZipFileobject until either the close method is invoked or the virtual machine exits.- See Also:
- Constant Field Values
 
 - 
LOCSIGpublic static final long LOCSIG - See Also:
- Constant Field Values
 
 - 
EXTSIGpublic static final long EXTSIG - See Also:
- Constant Field Values
 
 - 
CENSIGpublic static final long CENSIG - See Also:
- Constant Field Values
 
 - 
ENDSIGpublic static final long ENDSIG - See Also:
- Constant Field Values
 
 - 
LOCHDRpublic static final int LOCHDR - See Also:
- Constant Field Values
 
 - 
EXTHDRpublic static final int EXTHDR - See Also:
- Constant Field Values
 
 - 
CENHDRpublic static final int CENHDR - See Also:
- Constant Field Values
 
 - 
ENDHDRpublic static final int ENDHDR - See Also:
- Constant Field Values
 
 - 
LOCVERpublic static final int LOCVER - See Also:
- Constant Field Values
 
 - 
LOCFLGpublic static final int LOCFLG - See Also:
- Constant Field Values
 
 - 
LOCHOWpublic static final int LOCHOW - See Also:
- Constant Field Values
 
 - 
LOCTIMpublic static final int LOCTIM - See Also:
- Constant Field Values
 
 - 
LOCCRCpublic static final int LOCCRC - See Also:
- Constant Field Values
 
 - 
LOCSIZpublic static final int LOCSIZ - See Also:
- Constant Field Values
 
 - 
LOCLENpublic static final int LOCLEN - See Also:
- Constant Field Values
 
 - 
LOCNAMpublic static final int LOCNAM - See Also:
- Constant Field Values
 
 - 
LOCEXTpublic static final int LOCEXT - See Also:
- Constant Field Values
 
 - 
EXTCRCpublic static final int EXTCRC - See Also:
- Constant Field Values
 
 - 
EXTSIZpublic static final int EXTSIZ - See Also:
- Constant Field Values
 
 - 
EXTLENpublic static final int EXTLEN - See Also:
- Constant Field Values
 
 - 
CENVEMpublic static final int CENVEM - See Also:
- Constant Field Values
 
 - 
CENVERpublic static final int CENVER - See Also:
- Constant Field Values
 
 - 
CENFLGpublic static final int CENFLG - See Also:
- Constant Field Values
 
 - 
CENHOWpublic static final int CENHOW - See Also:
- Constant Field Values
 
 - 
CENTIMpublic static final int CENTIM - See Also:
- Constant Field Values
 
 - 
CENCRCpublic static final int CENCRC - See Also:
- Constant Field Values
 
 - 
CENSIZpublic static final int CENSIZ - See Also:
- Constant Field Values
 
 - 
CENLENpublic static final int CENLEN - See Also:
- Constant Field Values
 
 - 
CENNAMpublic static final int CENNAM - See Also:
- Constant Field Values
 
 - 
CENEXTpublic static final int CENEXT - See Also:
- Constant Field Values
 
 - 
CENCOMpublic static final int CENCOM - See Also:
- Constant Field Values
 
 - 
CENDSKpublic static final int CENDSK - See Also:
- Constant Field Values
 
 - 
CENATTpublic static final int CENATT - See Also:
- Constant Field Values
 
 - 
CENATXpublic static final int CENATX - See Also:
- Constant Field Values
 
 - 
CENOFFpublic static final int CENOFF - See Also:
- Constant Field Values
 
 - 
ENDSUBpublic static final int ENDSUB - See Also:
- Constant Field Values
 
 - 
ENDTOTpublic static final int ENDTOT - See Also:
- Constant Field Values
 
 - 
ENDSIZpublic static final int ENDSIZ - See Also:
- Constant Field Values
 
 - 
ENDOFFpublic static final int ENDOFF - See Also:
- Constant Field Values
 
 - 
ENDCOMpublic static final int ENDCOM - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
ZipFilepublic ZipFile(String name) throws IOException Opens a zip file for reading.First, if there is a security manager, its checkReadmethod is called with thenameargument as its argument to ensure the read is allowed.The UTF-8 charsetis 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- checkReadmethod doesn't allow read access to the file.
- See Also:
- SecurityManager.checkRead(java.lang.String)
 
 - 
ZipFilepublic ZipFile(File file, int mode) throws IOException Opens a newZipFileto read from the specifiedFileobject in the specified mode. The mode argument must be eitherOPEN_READorOPEN_READ | OPEN_DELETE.First, if there is a security manager, its checkReadmethod is called with thenameargument as its argument to ensure the read is allowed.The UTF-8 charsetis 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- checkReadmethod doesn't allow read access to the file, or its- checkDeletemethod doesn't allow deleting the file when the- OPEN_DELETEflag is set.
- IllegalArgumentException- if the- modeargument is invalid
- Since:
- 1.3
- See Also:
- SecurityManager.checkRead(java.lang.String)
 
 - 
ZipFilepublic ZipFile(File file) throws ZipException, IOException Opens a ZIP file for reading given the specified File object.The UTF-8 charsetis 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
 
 - 
ZipFilepublic ZipFile(File file, int mode, Charset charset) throws IOException Opens a newZipFileto read from the specifiedFileobject in the specified mode. The mode argument must be eitherOPEN_READorOPEN_READ | OPEN_DELETE.First, if there is a security manager, its checkReadmethod is called with thenameargument 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 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- checkReadmethod doesn't allow read access to the file,or its- checkDeletemethod doesn't allow deleting the file when the- OPEN_DELETEflag is set
- IllegalArgumentException- if the- modeargument is invalid
- Since:
- 1.7
- See Also:
- SecurityManager.checkRead(java.lang.String)
 
 - 
ZipFilepublic ZipFile(String name, Charset charset) throws IOException Opens a zip file for reading.First, if there is a security manager, its checkReadmethod is called with thenameargument as its argument to ensure the read is allowed.- Parameters:
- name- the name of the zip file
- charset- 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 occurred
- IOException- if an I/O error has occurred
- SecurityException- if a security manager exists and its- checkReadmethod doesn't allow read access to the file
- Since:
- 1.7
- See Also:
- SecurityManager.checkRead(java.lang.String)
 
 - 
ZipFilepublic ZipFile(File file, Charset charset) throws IOException Opens a ZIP file for reading given the specified File object.- Parameters:
- file- the ZIP file to be opened for reading
- charset- 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 occurred
- IOException- if an I/O error has occurred
- Since:
- 1.7
 
 
- 
 - 
Method Detail- 
getCommentpublic 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
 
 - 
getEntrypublic 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
 
 - 
getInputStreampublic InputStream getInputStream(ZipEntry entry) throws IOException 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
 
 - 
getNamepublic String getName() Returns the path name of the ZIP file.- Returns:
- the path name of the ZIP file
 
 - 
entriespublic 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
 
 - 
streampublic Stream<? extends ZipEntry> stream() Returns an orderedStreamover the ZIP file entries. Entries appear in theStreamin the order they appear in the central directory of the ZIP file.- Returns:
- an ordered Streamof entries in this ZIP file
- Throws:
- IllegalStateException- if the zip file has been closed
- Since:
- 1.8
 
 - 
sizepublic 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
 
 - 
closepublic void close() throws IOExceptionCloses the ZIP file.Closing this ZIP file will close all of the input streams previously returned by invocations of the getInputStreammethod.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Throws:
- IOException- if an I/O error has occurred
 
 - 
finalize@Deprecated(since="9", forRemoval=true) protected void finalize() throws IOException Deprecated, for removal: This API element is subject to removal in a future version.Thefinalizemethod has been deprecated and will be removed. It is implemented as a no-op. Subclasses that overridefinalizein order to perform cleanup should be modified to use alternative cleanup mechanisms and to remove the overridingfinalizemethod. The recommended cleanup for ZipFile object is to explicitly invokeclosemethod when it is no longer in use, or use try-with-resources. If thecloseis not invoked explicitly the resources held by this object will be released when the instance becomes unreachable.Ensures that the system resources held by this ZipFile object are released when there are no more references to it.- Overrides:
- finalizein class- Object
- Throws:
- IOException- if an I/O error has occurred
- See Also:
- WeakReference,- PhantomReference
 
 
- 
 
-