ZipFile (Java Platform SE 7 ) (original) (raw)
- 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 null argument to a constructor or method in this class will cause a NullPointerException to be thrown.
Field Summary
Fields
Modifier and Type Field and Description static int CENATT static int CENATX static int CENCOM static int CENCRC static int CENDSK static int CENEXT static int CENFLG static int CENHDR static int CENHOW static int CENLEN static int CENNAM static int CENOFF static long CENSIG static int CENSIZ static int CENTIM static int CENVEM static int CENVER static int ENDCOM static int ENDHDR static int ENDOFF static long ENDSIG static int ENDSIZ static int ENDSUB static int ENDTOT static int EXTCRC static int EXTHDR static int EXTLEN static long EXTSIG static int EXTSIZ static int LOCCRC static int LOCEXT static int LOCFLG static int LOCHDR static int LOCHOW static int LOCLEN static int LOCNAM static long LOCSIG static int LOCSIZ static int LOCTIM static int LOCVER static int OPEN_DELETE Mode flag to open a zip file and mark it for deletion. static int OPEN_READ Mode flag to open a zip file for reading. Constructor Summary
Constructors
Constructor and Description ZipFile(File file) Opens a ZIP file for reading given the specified File object. ZipFile(File file,Charset charset) Opens a ZIP file for reading given the specified File object. ZipFile(File file, int mode) Opens a new ZipFile to read from the specifiedFile object in the specified mode. ZipFile(File file, int mode,Charset charset) Opens a new ZipFile to read from the specifiedFile object in the specified mode. ZipFile(String name) Opens a zip file for reading. ZipFile(String name,Charset charset) Opens a zip file for reading. Method Summary
Methods
Modifier and Type Method and Description void close() Closes the ZIP file. Enumeration<? extends ZipEntry> entries() Returns an enumeration of the ZIP file entries. protected void finalize() Ensures that the system resources held by this ZipFile object are released when there are no more references to it. 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. * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang") `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`Field Detail
* #### OPEN\_READ public static final int OPEN_READ Mode flag to open a zip file for reading. See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.OPEN%5FREAD) * #### OPEN\_DELETE 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. See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.OPEN%5FDELETE) * #### LOCSIG public static final long LOCSIG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCSIG) * #### EXTSIG public static final long EXTSIG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.EXTSIG) * #### CENSIG public static final long CENSIG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENSIG) * #### ENDSIG public static final long ENDSIG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDSIG) * #### LOCHDR public static final int LOCHDR See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCHDR) * #### EXTHDR public static final int EXTHDR See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.EXTHDR) * #### CENHDR public static final int CENHDR See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENHDR) * #### ENDHDR public static final int ENDHDR See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDHDR) * #### LOCVER public static final int LOCVER See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCVER) * #### LOCFLG public static final int LOCFLG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCFLG) * #### LOCHOW public static final int LOCHOW See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCHOW) * #### LOCTIM public static final int LOCTIM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCTIM) * #### LOCCRC public static final int LOCCRC See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCCRC) * #### LOCSIZ public static final int LOCSIZ See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCSIZ) * #### LOCLEN public static final int LOCLEN See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCLEN) * #### LOCNAM public static final int LOCNAM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCNAM) * #### LOCEXT public static final int LOCEXT See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.LOCEXT) * #### EXTCRC public static final int EXTCRC See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.EXTCRC) * #### EXTSIZ public static final int EXTSIZ See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.EXTSIZ) * #### EXTLEN public static final int EXTLEN See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.EXTLEN) * #### CENVEM public static final int CENVEM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENVEM) * #### CENVER public static final int CENVER See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENVER) * #### CENFLG public static final int CENFLG See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENFLG) * #### CENHOW public static final int CENHOW See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENHOW) * #### CENTIM public static final int CENTIM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENTIM) * #### CENCRC public static final int CENCRC See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENCRC) * #### CENSIZ public static final int CENSIZ See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENSIZ) * #### CENLEN public static final int CENLEN See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENLEN) * #### CENNAM public static final int CENNAM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENNAM) * #### CENEXT public static final int CENEXT See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENEXT) * #### CENCOM public static final int CENCOM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENCOM) * #### CENDSK public static final int CENDSK See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENDSK) * #### CENATT public static final int CENATT See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENATT) * #### CENATX public static final int CENATX See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENATX) * #### CENOFF public static final int CENOFF See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.CENOFF) * #### ENDSUB public static final int ENDSUB See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDSUB) * #### ENDTOT public static final int ENDTOT See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDTOT) * #### ENDSIZ public static final int ENDSIZ See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDSIZ) * #### ENDOFF public static final int ENDOFF See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDOFF) * #### ENDCOM public static final int ENDCOM See Also: [Constant Field Values](../../../constant-values.html#java.util.zip.ZipFile.ENDCOM)Constructor Detail
* #### ZipFile public ZipFile([String](../../../java/lang/String.html "class in java.lang") name) throws [IOException](../../../java/io/IOException.html "class in java.io") 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](../../../java/nio/charset/Charset.html "class in java.nio.charset") is used to decode the entry names and comments. Parameters: `name` \- the name of the zip file Throws: `[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkRead` method doesn't allow read access to the file. See Also: [SecurityManager.checkRead(java.lang.String)](../../../java/lang/SecurityManager.html#checkRead%28java.lang.String%29) * #### ZipFile public ZipFile([File](../../../java/io/File.html "class in java.io") file, int mode) throws [IOException](../../../java/io/IOException.html "class in java.io") 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](../../../java/nio/charset/Charset.html "class in java.nio.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](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- 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](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the mode argument is invalid Since: 1.3 See Also: [SecurityManager.checkRead(java.lang.String)](../../../java/lang/SecurityManager.html#checkRead%28java.lang.String%29) * #### ZipFile public ZipFile([File](../../../java/io/File.html "class in java.io") file) throws [ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip"), [IOException](../../../java/io/IOException.html "class in java.io") Opens a ZIP file for reading given the specified File object. The UTF-8 [charset](../../../java/nio/charset/Charset.html "class in java.nio.charset") is used to decode the entry names and comments. Parameters: `file` \- the ZIP file to be opened for reading Throws: `[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred * #### ZipFile public ZipFile([File](../../../java/io/File.html "class in java.io") file, int mode, [Charset](../../../java/nio/charset/Charset.html "class in java.nio.charset") charset) throws [IOException](../../../java/io/IOException.html "class in java.io") 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 [charset](../../../java/nio/charset/Charset.html "class in java.nio.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](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- 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](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the mode argument is invalid Since: 1.7 See Also: [SecurityManager.checkRead(java.lang.String)](../../../java/lang/SecurityManager.html#checkRead%28java.lang.String%29) * #### ZipFile public ZipFile([String](../../../java/lang/String.html "class in java.lang") name, [Charset](../../../java/nio/charset/Charset.html "class in java.nio.charset") charset) throws [IOException](../../../java/io/IOException.html "class in java.io") 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 [charset](../../../java/nio/charset/Charset.html "class in java.nio.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](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its `checkRead` method doesn't allow read access to the file Since: 1.7 See Also: [SecurityManager.checkRead(java.lang.String)](../../../java/lang/SecurityManager.html#checkRead%28java.lang.String%29) * #### ZipFile public ZipFile([File](../../../java/io/File.html "class in java.io") file, [Charset](../../../java/nio/charset/Charset.html "class in java.nio.charset") charset) throws [IOException](../../../java/io/IOException.html "class in java.io") Opens a ZIP file for reading given the specified File object. Parameters: `file` \- the ZIP file to be opened for reading `charset` \- The [charset](../../../java/nio/charset/Charset.html "class in java.nio.charset") to be used to decode the ZIP entry name and comment (ignored if the [ language encoding bit](package-summary.html#lang%5Fencoding) of the ZIP entry's general purpose bit flag is set). Throws: `[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred Since: 1.7Method Detail
* #### getComment public [String](../../../java/lang/String.html "class in java.lang") getComment() Returns the zip file comment, or null if none. Returns: the comment string for the zip file, or null if none Throws: `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the zip file has been closed Since 1.7 * #### getEntry public [ZipEntry](../../../java/util/zip/ZipEntry.html "class in java.util.zip") getEntry([String](../../../java/lang/String.html "class in java.lang") 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](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the zip file has been closed * #### getInputStream public [InputStream](../../../java/io/InputStream.html "class in java.io") getInputStream([ZipEntry](../../../java/util/zip/ZipEntry.html "class in java.util.zip") entry) throws [IOException](../../../java/io/IOException.html "class in java.io") 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](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the zip file has been closed * #### getName public [String](../../../java/lang/String.html "class in java.lang") getName() Returns the path name of the ZIP file. Returns: the path name of the ZIP file * #### entries public [Enumeration](../../../java/util/Enumeration.html "interface in java.util")<? extends [ZipEntry](../../../java/util/zip/ZipEntry.html "class in java.util.zip")> entries() Returns an enumeration of the ZIP file entries. Returns: an enumeration of the ZIP file entries Throws: `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the zip file has been closed * #### size public int size() Returns the number of entries in the ZIP file. Returns: the number of entries in the ZIP file Throws: `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the zip file has been closed * #### close public void close() throws [IOException](../../../java/io/IOException.html "class in java.io") Closes the ZIP file. Closing this ZIP file will close all of the input streams previously returned by invocations of the [getInputStream](../../../java/util/zip/ZipFile.html#getInputStream%28java.util.zip.ZipEntry%29) method. **Specified by:** `[close](../../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../../java/io/Closeable.html "interface in java.io")` **Specified by:** `[close](../../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../../java/lang/AutoCloseable.html "interface in java.lang")` Throws: `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred * #### finalize protected void finalize() throws [IOException](../../../java/io/IOException.html "class in java.io") 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. **Overrides:** `[finalize](../../../java/lang/Object.html#finalize%28%29)` in class `[Object](../../../java/lang/Object.html "class in java.lang")` Throws: `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred See Also: [close()](../../../java/util/zip/ZipFile.html#close%28%29)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.