W3cubDocs

Class ZipFile

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 null argument to a constructor or method in this class will cause a NullPointerException to be thrown.

Fields

OPEN_READ

public static final int OPEN_READ

Mode flag to open a zip file for reading.

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.

LOCSIG

public static final long LOCSIG

EXTSIG

public static final long EXTSIG

CENSIG

public static final long CENSIG

ENDSIG

public static final long ENDSIG

LOCHDR

public static final int LOCHDR

EXTHDR

public static final int EXTHDR

CENHDR

public static final int CENHDR

ENDHDR

public static final int ENDHDR

LOCVER

public static final int LOCVER

LOCFLG

public static final int LOCFLG

LOCHOW

public static final int LOCHOW

LOCTIM

public static final int LOCTIM

LOCCRC

public static final int LOCCRC

LOCSIZ

public static final int LOCSIZ

LOCLEN

public static final int LOCLEN

LOCNAM

public static final int LOCNAM

LOCEXT

public static final int LOCEXT

EXTCRC

public static final int EXTCRC

EXTSIZ

public static final int EXTSIZ

EXTLEN

public static final int EXTLEN

CENVEM

public static final int CENVEM

CENVER

public static final int CENVER

CENFLG

public static final int CENFLG

CENHOW

public static final int CENHOW

CENTIM

public static final int CENTIM

CENCRC

public static final int CENCRC

CENSIZ

public static final int CENSIZ

CENLEN

public static final int CENLEN

CENNAM

public static final int CENNAM

CENEXT

public static final int CENEXT

CENCOM

public static final int CENCOM

CENDSK

public static final int CENDSK

CENATT

public static final int CENATT

CENATX

public static final int CENATX

CENOFF

public static final int CENOFF

ENDSUB

public static final int ENDSUB

ENDTOT

public static final int ENDTOT

ENDSIZ

public static final int ENDSIZ

ENDOFF

public static final int ENDOFF

ENDCOM

public static final int ENDCOM

Constructors

ZipFile

public ZipFile(String name)
        throws IOException

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 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 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:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(File file,
               int mode)
        throws IOException

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 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 - 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
Since:: 1.3
See Also:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(File file)
        throws ZipException,
               IOException

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 occurred; IOException - if an I/O error has occurred

ZipFile

public ZipFile(File file,
               int mode,
               Charset charset)
        throws IOException

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 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 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
Since:: 1.7
See Also:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(String name,
               Charset charset)
        throws IOException

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 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 checkRead method doesn't allow read access to the file
Since:: 1.7
See Also:: SecurityManager.checkRead(java.lang.String)

ZipFile

public 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

Methods

getComment

public 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

getEntry

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

getInputStream

public 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

getName

public String getName()

Returns the path name of the ZIP file.

Returns:: the path name of the ZIP file

entries

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

stream

public Stream<? extends ZipEntry> stream()

Return an ordered Stream over the ZIP file entries. Entries appear in the Stream 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

public void close()
           throws IOException

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 interface Closeable
Specified by:: close in interface AutoCloseable
Throws:: IOException - if an I/O error has occurred

finalize

protected void finalize()
                 throws IOException

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 in class Object
Throws:: IOException - if an I/O error has occurred
See Also:: close()

© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.