public class ZipFile extends Object implements Closeable
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.commons.compress.archivers.zip.ZipArchiveEntry
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 SeekableByteChannel under the
covers and supports compressed and uncompressed entries. As of
Apache Commons Compress 1.3 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:
org.apache.commons.compress.archivers.zip.ZipArchiveEntry
instances.Constructor and Description |
---|
ZipFile(File f)
Opens the given file for reading, assuming "UTF8" for file names.
|
ZipFile(File f,
String encoding)
Opens the given file for reading, assuming the specified
encoding for file names and scanning for unicode extra fields.
|
ZipFile(File f,
String encoding,
boolean useUnicodeExtraFields)
Opens the given file for reading, assuming the specified
encoding for file names.
|
ZipFile(File f,
String encoding,
boolean useUnicodeExtraFields,
boolean ignoreLocalFileHeader)
Opens the given file for reading, assuming the specified
encoding for file names.
|
ZipFile(Path path)
Opens the given path for reading, assuming "UTF8" for file names.
|
ZipFile(Path path,
String encoding)
Opens the given path for reading, assuming the specified
encoding for file names and scanning for unicode extra fields.
|
ZipFile(Path path,
String encoding,
boolean useUnicodeExtraFields)
Opens the given path for reading, assuming the specified
encoding for file names.
|
ZipFile(Path path,
String encoding,
boolean useUnicodeExtraFields,
boolean ignoreLocalFileHeader)
Opens the given path for reading, assuming the specified
encoding for file names.
|
ZipFile(SeekableByteChannel channel)
Opens the given channel for reading, assuming "UTF8" for file names.
|
ZipFile(SeekableByteChannel channel,
String encoding)
Opens the given channel for reading, assuming the specified
encoding for file names.
|
ZipFile(SeekableByteChannel channel,
String archiveName,
String encoding,
boolean useUnicodeExtraFields)
Opens the given channel for reading, assuming the specified
encoding for file names.
|
ZipFile(SeekableByteChannel channel,
String archiveName,
String encoding,
boolean useUnicodeExtraFields,
boolean ignoreLocalFileHeader)
Opens the given channel for reading, assuming the specified
encoding for file names.
|
ZipFile(String name)
Opens the given file for reading, assuming "UTF8".
|
ZipFile(String name,
String encoding)
Opens the given file for reading, assuming the specified
encoding for file names, scanning unicode extra fields.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canReadEntryData(ZipArchiveEntry ze)
Whether this class is able to read the given entry.
|
void |
close()
Closes the archive.
|
static void |
closeQuietly(ZipFile zipfile)
close a zipfile quietly; throw no io fault, do nothing
on a null parameter
|
void |
copyRawEntries(ZipArchiveOutputStream target,
ZipArchiveEntryPredicate predicate)
Transfer selected entries from this zipfile to a given #ZipArchiveOutputStream.
|
protected void |
finalize()
Ensures that the close method of this zipfile is called when
there are no more references to it.
|
String |
getEncoding()
The encoding to use for file names and the file comment.
|
Enumeration<ZipArchiveEntry> |
getEntries()
Returns all entries.
|
Iterable<ZipArchiveEntry> |
getEntries(String name)
Returns all named entries in the same order they appear within
the archive's central directory.
|
Enumeration<ZipArchiveEntry> |
getEntriesInPhysicalOrder()
Returns all entries in physical order.
|
Iterable<ZipArchiveEntry> |
getEntriesInPhysicalOrder(String name)
Returns all named entries in the same order their contents
appear within the archive.
|
ZipArchiveEntry |
getEntry(String name)
Returns a named entry - or
null if no entry by
that name exists. |
InputStream |
getInputStream(ZipArchiveEntry ze)
Returns an InputStream for reading the contents of the given entry.
|
InputStream |
getRawInputStream(ZipArchiveEntry ze)
Expose the raw stream of the archive entry (compressed form).
|
String |
getUnixSymlink(ZipArchiveEntry entry)
Convenience method to return the entry's content as a String if isUnixSymlink()
returns true for it, otherwise returns null.
|
public ZipFile(File f) throws IOException
f
- the archive.IOException
- if an error occurs while reading the file.public ZipFile(Path path) throws IOException
path
- path to the archive.IOException
- if an error occurs while reading the file.public ZipFile(String name) throws IOException
name
- name of the archive.IOException
- if an error occurs while reading the file.public ZipFile(String name, String encoding) throws IOException
name
- name of the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodingIOException
- if an error occurs while reading the file.public ZipFile(File f, String encoding) throws IOException
f
- the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodingIOException
- if an error occurs while reading the file.public ZipFile(Path path, String encoding) throws IOException
path
- path to the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodingIOException
- if an error occurs while reading the file.public ZipFile(File f, String encoding, boolean useUnicodeExtraFields) throws IOException
f
- the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.IOException
- if an error occurs while reading the file.public ZipFile(Path path, String encoding, boolean useUnicodeExtraFields) throws IOException
path
- path to the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.IOException
- if an error occurs while reading the file.public ZipFile(File f, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) throws IOException
By default the central directory record and all local file headers of the archive will be read immediately
which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader
parameter
can be set to true
which restricts parsing to the central directory. Unfortunately the local file header
may contain information not present inside of the central directory which will not be available when the argument
is set to true
. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader
to true
means useUnicodeExtraFields
will be ignored effectively. Also
getRawInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry)
is always going to return null
if ignoreLocalFileHeader
is true
.
f
- the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.ignoreLocalFileHeader
- whether to ignore information
stored inside the local file header (see the notes in this method's javadoc)IOException
- if an error occurs while reading the file.public ZipFile(Path path, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) throws IOException
By default the central directory record and all local file headers of the archive will be read immediately
which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader
parameter
can be set to true
which restricts parsing to the central directory. Unfortunately the local file header
may contain information not present inside of the central directory which will not be available when the argument
is set to true
. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader
to true
means useUnicodeExtraFields
will be ignored effectively. Also
getRawInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry)
is always going to return null
if ignoreLocalFileHeader
is true
.
path
- path to the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.ignoreLocalFileHeader
- whether to ignore information
stored inside the local file header (see the notes in this method's javadoc)IOException
- if an error occurs while reading the file.public ZipFile(SeekableByteChannel channel) throws IOException
SeekableInMemoryByteChannel
allows you to read from an in-memory archive.
channel
- the archive.IOException
- if an error occurs while reading the file.public ZipFile(SeekableByteChannel channel, String encoding) throws IOException
SeekableInMemoryByteChannel
allows you to read from an in-memory archive.
channel
- the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodingIOException
- if an error occurs while reading the file.public ZipFile(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields) throws IOException
SeekableInMemoryByteChannel
allows you to read from an in-memory archive.
channel
- the archive.archiveName
- name of the archive, used for error messages only.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.IOException
- if an error occurs while reading the file.public ZipFile(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) throws IOException
SeekableInMemoryByteChannel
allows you to read from an in-memory archive.
By default the central directory record and all local file headers of the archive will be read immediately
which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader
parameter
can be set to true
which restricts parsing to the central directory. Unfortunately the local file header
may contain information not present inside of the central directory which will not be available when the argument
is set to true
. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader
to true
means useUnicodeExtraFields
will be ignored effectively. Also
getRawInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry)
is always going to return null
if ignoreLocalFileHeader
is true
.
channel
- the archive.archiveName
- name of the archive, used for error messages only.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the file names.ignoreLocalFileHeader
- whether to ignore information
stored inside the local file header (see the notes in this method's javadoc)IOException
- if an error occurs while reading the file.public String getEncoding()
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
- if an error occurs closing the archive.public static void closeQuietly(ZipFile zipfile)
zipfile
- file to close, can be nullpublic Enumeration<ZipArchiveEntry> getEntries()
Entries will be returned in the same order they appear within the archive's central directory.
ZipArchiveEntry
instancespublic Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder()
Entries will be returned in the same order their contents appear within the archive.
ZipArchiveEntry
instancespublic ZipArchiveEntry getEntry(String name)
null
if 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.
name
- name of the entry.null
if not present.public Iterable<ZipArchiveEntry> getEntries(String name)
name
- name of the entry.public Iterable<ZipArchiveEntry> getEntriesInPhysicalOrder(String name)
name
- name of the entry.public boolean canReadEntryData(ZipArchiveEntry ze)
May return false if it is set up to use encryption or a compression method that hasn't been implemented yet.
ze
- the entrypublic InputStream getRawInputStream(ZipArchiveEntry ze)
This method does not relate to how/if we understand the payload in the stream, since we really only intend to move it on to somewhere else.
ze
- The entry to get the stream forpublic void copyRawEntries(ZipArchiveOutputStream target, ZipArchiveEntryPredicate predicate) throws IOException
This method transfers entries based on the central directory of the zip file.
target
- The zipArchiveOutputStream to write the entries topredicate
- A predicate that selects which entries to writeIOException
- on errorpublic InputStream getInputStream(ZipArchiveEntry ze) throws IOException
ze
- the entry to get the stream for.InputStreamStatistics
.IOException
- if unable to create an input stream from the zipentrypublic String getUnixSymlink(ZipArchiveEntry entry) throws IOException
Convenience method to return the entry's content as a String if isUnixSymlink() returns true for it, otherwise returns null.
This method assumes the symbolic link's file name uses the same encoding that as been specified for this ZipFile.
entry
- ZipArchiveEntry object that represents the symbolic linkIOException
- problem with content's input streamCopyright © 2002–2022 The Apache Software Foundation. All rights reserved.