@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)

Package de.schlichtherle.truezip.zip

A drop-in replacement for the package java.util.zip for reading and writing ZIP files.

See: Description

Interface Summary

Interface	Description
WinZipAesParameters	The parameters of this interface are used with WinZip AES encrypted entries.
ZipCharsetParameters	Defines the default character set for accessing ZIP files.
ZipCryptoParameters	A marker interface for ZIP crypto parameters.
ZipEntryFactory<E extends ZipEntry>	A factory for ZipEntrys.
ZipFileParameters<E extends ZipEntry>	Provides parameters for reading ZIP files.
ZipOutputStreamParameters	An interface for ZipOutputStream parameters.
ZipParameters	A marker interface for ZIP parameters.
ZipParametersProvider	A provider of ZipParameters for a given type.

Class Summary

Class	Description
RawZipFile<E extends ZipEntry>	Provides unsafe (raw) access to a ZIP file using unsynchronized methods and shared ZipEntry instances.
RawZipOutputStream<E extends ZipEntry>	Provides unsafe (raw) access to a ZIP file using unsynchronized methods and shared ZipEntry instances.
ZipEntry	Drop-in replacement for java.util.zip.ZipEntry.
ZipFile	Drop-in replacement for java.util.zip.ZipFile.
ZipOutputStream	Drop-in replacement for java.util.zip.ZipOutputStream.

Enum Summary

Enum	Description
DateTimeConverter	Converts Java time values to DOS date/time values and vice versa.

Exception Summary

Exception	Description
CRC32Exception	Thrown to indicate a CRC32 mismatch between the declared value in the Central File Header and the Data Descriptor or between the declared value and the computed value from the decompressed data.
ZipAuthenticationException	Thrown to indicate that an authenticated ZIP entry has been tampered with.
ZipCryptoException	Thrown if there is an issue when reading or writing an encrypted ZIP file or entry.
ZipKeyException	Thrown to indicate that retrieving a key to encrypt or decrypt or authenticate a ZIP entry has failed for some reason.
ZipParametersException	Thrown to indicate that no suitable ZIP parameters have been provided or something is wrong with these parameters.

Package de.schlichtherle.truezip.zip Description

A drop-in replacement for the package java.util.zip for reading and writing ZIP files.

The classes in this package read and write ZIP files according to a subset of PKWARE's ZIP File Format Specification, Version 6.3.2 from September 28, 2007. The subset has been selected in order to achieve the following objectives:

• Full interoperability with ZIP files read or written by the package java.util.zip of Oracle's Java SE 7 implementation.
• Support for appending to existing ZIP files.
• Support for recovering lost entries when reading a ZIP file.
• Support for reading and writing encrypted or authenticated ZIP entries. Currently, only the WinZip AES Specification is supported. You need to implement the interface WinZipAesParameters and inject it for reading and writing to the ZipFile.setCryptoParameters(ZipCryptoParameters) and ZipOutputStream.setCryptoParameters(ZipCryptoParameters) classes.
• Support for reading and writing BZIP2 compressed ZIP entries.
• Support for selectable character sets, in particular IBM Code Page 437 (alias IBM PC) for PKZIP compatibility and UTF-8 for Java Archive (JAR) compatibility. Note that using any other character set except CP437 or UTF-8 is strongly discouraged because it will result in interoperability issues with third party tools, especially when sharing archive files between different locales!
• Support for reading and writing external file attributes.
• Support for reading and writing ZIP64 extensions with the following restrictions:
  1. The maximum file size is Long.MAX_VALUE.
  2. The maximum number of entries in the Central Directory is Integer.MAX_VALUE.
  3. The offsets in ZIP64 files must respect a preamble if present, i.e. they must be exact. This is in contrast to ZIP32 files where the offsets do not need to respect a preamble if present. Preambles are primarily used to contain self extracting (SFX) executable code.
• ZipFile supports reading archive data from the random access read only interface ReadOnlyFile, which allows to read archive data from composite data sources like e.g. RAES encrypted ZIP files directly without the need to decrypt them to a temporary file first.