org.apache.commons.compress.archivers.zip

Class ZipFile

java.lang.Object

org.apache.commons.compress.archivers.zip.ZipFile

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ZipFile
extends java.lang.Object
implements java.io.Closeable

Replacement for 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:

• There is no getName method.
• entries has been renamed to getEntries.
• getEntries and getEntry return org.apache.commons.compress.archivers.zip.ZipArchiveEntry instances.
• close is allowed to throw IOException.

Constructor Summary

Constructors

Constructor and Description
ZipFile(java.io.File f) Opens the given file for reading, assuming "UTF8" for file names.
ZipFile(java.io.File f, java.lang.String encoding) Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.
ZipFile(java.io.File f, java.lang.String encoding, boolean useUnicodeExtraFields) Opens the given file for reading, assuming the specified encoding for file names.
ZipFile(java.nio.channels.SeekableByteChannel channel) Opens the given channel for reading, assuming "UTF8" for file names.
ZipFile(java.nio.channels.SeekableByteChannel channel, java.lang.String encoding) Opens the given channel for reading, assuming the specified encoding for file names.
ZipFile(java.nio.channels.SeekableByteChannel channel, java.lang.String archiveName, java.lang.String encoding, boolean useUnicodeExtraFields) Opens the given channel for reading, assuming the specified encoding for file names.
ZipFile(java.lang.String name) Opens the given file for reading, assuming "UTF8".
ZipFile(java.lang.String name, java.lang.String encoding) Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.

Method Summary

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.
java.lang.String	getEncoding() The encoding to use for filenames and the file comment.
java.util.Enumeration<ZipArchiveEntry>	getEntries() Returns all entries.
java.lang.Iterable<ZipArchiveEntry>	getEntries(java.lang.String name) Returns all named entries in the same order they appear within the archive's central directory.
java.util.Enumeration<ZipArchiveEntry>	getEntriesInPhysicalOrder() Returns all entries in physical order.
java.lang.Iterable<ZipArchiveEntry>	getEntriesInPhysicalOrder(java.lang.String name) Returns all named entries in the same order their contents appear within the archive.
ZipArchiveEntry	getEntry(java.lang.String name) Returns a named entry - or null if no entry by that name exists.
java.io.InputStream	getInputStream(ZipArchiveEntry ze) Returns an InputStream for reading the contents of the given entry.
java.io.InputStream	getRawInputStream(ZipArchiveEntry ze) Expose the raw stream of the archive entry (compressed form).
java.lang.String	getUnixSymlink(ZipArchiveEntry entry) Convenience method to return the entry's content as a String if isUnixSymlink() returns true for it, otherwise returns null.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipFile

public ZipFile(java.io.File f)
        throws java.io.IOException

Opens the given file for reading, assuming "UTF8" for file names.

Parameters:

f - the archive.

Throws:

java.io.IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(java.lang.String name)
        throws java.io.IOException

Opens the given file for reading, assuming "UTF8".

Parameters:

name - name of the archive.

Throws:

java.io.IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(java.lang.String name,
               java.lang.String encoding)
        throws java.io.IOException

Opens 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:

java.io.IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(java.io.File f,
               java.lang.String encoding)
        throws java.io.IOException

Opens 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:

java.io.IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(java.io.File f,
               java.lang.String encoding,
               boolean useUnicodeExtraFields)
        throws java.io.IOException

Opens 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:

java.io.IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(java.nio.channels.SeekableByteChannel channel)
        throws java.io.IOException

Opens the given channel for reading, assuming "UTF8" for file names.

SeekableInMemoryByteChannel allows you to read from an in-memory archive.

Parameters:

channel - the archive.

Throws:

java.io.IOException - if an error occurs while reading the file.

Since:

1.13

ZipFile

public ZipFile(java.nio.channels.SeekableByteChannel channel,
               java.lang.String encoding)
        throws java.io.IOException

Opens the given channel for reading, assuming the specified encoding for file names.

SeekableInMemoryByteChannel allows you to read from an in-memory archive.

Parameters:

channel - the archive.

encoding - the encoding to use for file names, use null for the platform's default encoding

Throws:

java.io.IOException - if an error occurs while reading the file.

Since:

1.13

ZipFile

public ZipFile(java.nio.channels.SeekableByteChannel channel,
               java.lang.String archiveName,
               java.lang.String encoding,
               boolean useUnicodeExtraFields)
        throws java.io.IOException

Opens the given channel for reading, assuming the specified encoding for file names.

SeekableInMemoryByteChannel allows you to read from an in-memory archive.

Parameters:

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 encoding

useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.

Throws:

java.io.IOException - if an error occurs while reading the file.

Since:

1.13

Method Detail

getEncoding

public java.lang.String getEncoding()

The encoding to use for filenames and the file comment.

Returns:

null if using the platform's default character encoding.

close

public void close()
           throws java.io.IOException

Closes the archive.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an error occurs closing the archive.

closeQuietly

public static void closeQuietly(ZipFile zipfile)

close a zipfile quietly; throw no io fault, do nothing on a null parameter

Parameters:

zipfile - file to close, can be null

getEntries

public java.util.Enumeration<ZipArchiveEntry> getEntries()

Returns all entries.

Entries will be returned in the same order they appear within the archive's central directory.

Returns:

all entries as ZipArchiveEntry instances

getEntriesInPhysicalOrder

public java.util.Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder()

Returns all entries in physical order.

Entries will be returned in the same order their contents appear within the archive.

Returns:

all entries as ZipArchiveEntry instances

Since:

1.1

getEntry

public ZipArchiveEntry getEntry(java.lang.String name)

Returns a named entry - or 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.

Parameters:

name - name of the entry.

Returns:

the ZipArchiveEntry corresponding to the given name - or null if not present.

getEntries

public java.lang.Iterable<ZipArchiveEntry> getEntries(java.lang.String name)

Returns all named entries in the same order they appear within the archive's central directory.

Parameters:

name - name of the entry.

Returns:

the Iterable<ZipArchiveEntry> corresponding to the given name

Since:

1.6

getEntriesInPhysicalOrder

public java.lang.Iterable<ZipArchiveEntry> getEntriesInPhysicalOrder(java.lang.String name)

Returns all named entries in the same order their contents appear within the archive.

Parameters:

name - name of the entry.

Returns:

the Iterable<ZipArchiveEntry> corresponding to the given name

Since:

1.6

canReadEntryData

public boolean canReadEntryData(ZipArchiveEntry ze)

Whether 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 - the entry

Returns:

whether this class is able to read the given entry.

Since:

1.1

getRawInputStream

public java.io.InputStream getRawInputStream(ZipArchiveEntry ze)

Expose the raw stream of the archive entry (compressed form).

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.

Parameters:

ze - The entry to get the stream for

Returns:

The raw input stream containing (possibly) compressed data.

Since:

1.11

copyRawEntries

public void copyRawEntries(ZipArchiveOutputStream target,
                           ZipArchiveEntryPredicate predicate)
                    throws java.io.IOException

Transfer selected entries from this zipfile to a given #ZipArchiveOutputStream. Compression and all other attributes will be as in this file.

This method transfers entries based on the central directory of the zip file.

Parameters:

target - The zipArchiveOutputStream to write the entries to

predicate - A predicate that selects which entries to write

Throws:

java.io.IOException - on error

getInputStream

public java.io.InputStream getInputStream(ZipArchiveEntry ze)
                                   throws java.io.IOException

Returns 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. The returned stream implements InputStreamStatistics.

Throws:

java.io.IOException - if unable to create an input stream from the zipentry

getUnixSymlink

public java.lang.String getUnixSymlink(ZipArchiveEntry entry)
                                throws java.io.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.

Parameters:

entry - ZipArchiveEntry object that represents the symbolic link

Returns:

entry's content as a String

Throws:

java.io.IOException - problem with content's input stream

Since:

1.5