Class ZipFile
- All Implemented Interfaces:
- Closeable,- AutoCloseable
java.util.ZipFile.
 This class adds support for file name encodings other than UTF-8
 (which is required to work on ZIP files created by native zip tools
 and is able to skip a preamble like the one found in self
 extracting archives.  Furthermore it returns instances of
 org.apache.tools.zip.ZipEntry instead of
 java.util.zip.ZipEntry.
It doesn't extend java.util.zip.ZipFile as it would
 have to reimplement all methods anyway.  Like
 java.util.ZipFile, it uses RandomAccessFile under the
 covers and supports compressed and uncompressed entries.  As of
 Apache Ant 1.9.0 it also transparently supports Zip64
 extensions and thus individual entries and archives larger than 4
 GB or with more than 65536 entries.
The method signatures mimic the ones of
 java.util.zip.ZipFile, with a couple of exceptions:
 
- There is no getName method.
- entries has been renamed to getEntries.
- getEntries and getEntry return
   org.apache.tools.zip.ZipEntryinstances.
- close is allowed to throw IOException.
- 
Constructor SummaryConstructorsConstructorDescriptionOpens the given file for reading, assuming the platform's native encoding for file names.Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.Opens the given file for reading, assuming the specified encoding for file names.Opens the given file for reading, assuming the platform's native encoding for file names.Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanWhether this class is able to read the given entry.voidclose()Closes the archive.static voidcloseQuietly(ZipFile zipfile) close a zipfile quietly; throw no io fault, do nothing on a null parameterprotected voidfinalize()Ensures that the close method of this zipfile is called when there are no more references to it.The encoding to use for filenames and the file comment.Returns all entries.getEntries(String name) Returns all named entries in the same order they appear within the archive's central directory.Returns all entries in physical order.Returns all named entries in the same order their contents appear within the archive.Returns a named entry - ornullif no entry by that name exists.Returns an InputStream for reading the contents of the given entry.getName()
- 
Constructor Details- 
ZipFileOpens the given file for reading, assuming the platform's native encoding for file names.- Parameters:
- f- the archive.
- Throws:
- IOException- if an error occurs while reading the file.
 
- 
ZipFileOpens the given file for reading, assuming the platform's native encoding for file names.- Parameters:
- name- name of the archive.
- Throws:
- IOException- if an error occurs while reading the file.
 
- 
ZipFileOpens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.- Parameters:
- name- name of the archive.
- encoding- the encoding to use for file names, use null for the platform's default encoding
- Throws:
- IOException- if an error occurs while reading the file.
 
- 
ZipFileOpens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.- Parameters:
- f- the archive.
- encoding- the encoding to use for file names, use null for the platform's default encoding
- Throws:
- IOException- if an error occurs while reading the file.
 
- 
ZipFileOpens the given file for reading, assuming the specified encoding for file names.- Parameters:
- f- the archive.
- encoding- the encoding to use for file names, use null for the platform's default encoding
- useUnicodeExtraFields- whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
- Throws:
- IOException- if an error occurs while reading the file.
 
 
- 
- 
Method Details- 
getEncodingThe encoding to use for filenames and the file comment.- Returns:
- null if using the platform's default character encoding.
 
- 
closeCloses the archive.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Throws:
- IOException- if an error occurs closing the archive.
 
- 
closeQuietlyclose a zipfile quietly; throw no io fault, do nothing on a null parameter- Parameters:
- zipfile- file to close, can be null
 
- 
getEntriesReturns all entries.Entries will be returned in the same order they appear within the archive's central directory. - Returns:
- all entries as ZipEntryinstances
 
- 
getEntriesInPhysicalOrderReturns all entries in physical order.Entries will be returned in the same order their contents appear within the archive. - Returns:
- all entries as ZipEntryinstances
- Since:
- Ant 1.9.0
 
- 
getEntryReturns a named entry - ornullif no entry by that name exists.If multiple entries with the same name exist the first entry in the archive's central directory by that name is returned. - Parameters:
- name- name of the entry.
- Returns:
- the ZipEntry corresponding to the given name - or
 nullif not present.
 
- 
getEntriesReturns all named entries in the same order they appear within the archive's central directory.- Parameters:
- name- name of the entry.
- Returns:
- the Iterable<ZipEntry> corresponding to the given name
- Since:
- 1.9.2
 
- 
getEntriesInPhysicalOrderReturns all named entries in the same order their contents appear within the archive.- Parameters:
- name- name of the entry.
- Returns:
- the Iterable<ZipEntry> corresponding to the given name
- Since:
- 1.9.2
 
- 
canReadEntryDataWhether this class is able to read the given entry.May return false if it is set up to use encryption or a compression method that hasn't been implemented yet. - Parameters:
- ze- ZipEntry
- Returns:
- boolean
 
- 
getInputStreamReturns an InputStream for reading the contents of the given entry.- Parameters:
- ze- the entry to get the stream for.
- Returns:
- a stream to read the entry from.
- Throws:
- IOException- if unable to create an input stream from the zipentry
- ZipException- if the zipentry uses an unsupported feature
 
- 
getName
- 
finalizeEnsures that the close method of this zipfile is called when there are no more references to it.
 
-