All Classes and Interfaces

Class
Description
Encapsulates code common to LZ77 decompressors.
A common base class for Unicode extra information extra fields.
 
Represents an archive entry in the "ar" format.
Implements the "ar" archive format as an input stream.
Implements the "ar" archive format as an output stream.
 
Represents an entry of an archive.
Archiver related Exception
Archive input streams MUST override the InputStream.read(byte[], int, int) - or ArchiveInputStream.read() - method so that reading from the stream generates EOF for the end of data in each entry as well as at the end of the file proper.
Archive output stream implementations are expected to override the OutputStream.write(byte[], int, int) method to improve performance.
Provides a high level API for creating archives.
 
Factory to create Archive[In|Out]putStreams from names or the first bytes of the InputStream.
Generic Archive utilities
An entry in an ARJ archive.
The known values for HostOs.
Implements the "arj" archive format as an InputStream.
Adds Unix file permission and UID/GID fields as well as symbolic link handling.
Binary tree of positive values.
 
Reads bits from an InputStream.
Iterates over the bits of an InputStream.
CompressorInputStream for the LZ4 block format.
 
CompressorOutputStream for the LZ4 block format.
 
Encapsulates the Burrows-Wheeler sorting algorithm needed by BZip2CompressorOutputStream.
NIO backed bounded input stream for reading a predefined amount of data from.
A stream that limits reading from a wrapped stream to a given number of bytes.
 
InputStream that delegates requests to the underlying SeekableByteChannel, making sure that only bytes from a certain range can be read.
Utility methods for reading and writing bytes.
Used to consume bytes.
Used to supply bytes.
An input stream that decompresses from the BZip2 format to be read as any other stream.
 
An output stream that compresses into the BZip2 format into another stream.
 
Constants for both the compress and decompress BZip2 classes.
Utility code for the BZip2 compression format.
Change holds meta information about a change.
ChangeSet collects and performs changes to an archive.
Performs ChangeSet operations on a stream.
Used in perform to abstract out getting entries and streams for those entries.
 
 
Stores the results of an performed ChangeSet operation.
An interface added to allow access to the character set associated with an NioZipEncoding, without requiring a new method to be added to ZipEncoding.
Character encoding names required of every implementation of the Java platform.
Charsets required of every implementation of the Java platform.
A stream that calculates the checksum of the data read.
A stream that verifies the checksum of the data read once the stream is exhausted.
Circular byte buffer.
 
 
Callback that is informed about a closable resource that has been wrapped around a passed in stream or channel by Expander or Archiver when Expander or Archiver no longer need them.
 
Re-implements FilterInputStream.close() to do nothing.
 
Base Codec class.
 
 
 
 
 
 
 
 
Compressor related exception
 
 
Factory to create Compressor[In|Out]putStreams from names.
Input stream that tracks the number of bytes read.
Stream that tracks the number of bytes read.
A cpio archive consists of a sequence of files.
CpioArchiveInputStream is a stream for reading cpio streams.
CpioArchiveOutputStream is a stream for writing CPIO streams.
All constants needed by CPIO.
Package private utility class for Cpio
A simple class the hold and calculate the CRC for sanity checking of the data.
A stream that verifies the CRC of the data read once the stream is exhausted.
Deflate64 decompressor.
Deflate decompressor.
Deflate compressor.
Parameters for the Deflate compressor.
 
Directory entry.
Various constants associated with dump archives.
The type of compression.
The type of tape segment.
This class represents an entry in a Dump archive.
 
Archive entry as stored on tape.
 
Dump Archive Exception
The DumpArchiveInputStream reads a UNIX dump archive as an InputStream.
This class represents identifying information about a Dump archive volume.
Various utilities for dump archives.
Provides information about ArchiveEntry stream offsets.
Provides a high level API for expanding archives.
 
 
The implode compression method was added to PKZIP 1.01 released in 1989.
Controls details of parsing zip extra fields.
ZipExtraField related methods
"enum" for the possible actions to take if the extra field cannot be parsed.
ScatterGatherBackingStore that is backed by a file.
File name mapping code for the compression formats.
Generic file name utilities.
This class supports writing to an OutputStream or WritableByteChannel in fixed length blocks.
Helper class to provide channel wrapper for arbitrary output stream that doesn't alter the size of writes.
Re-implements FilterOutputStream.flush() to do nothing.
The unit of solid compression.
CompressorInputStream for the LZ4 frame format.
CompressorOutputStream for the LZ4 frame format.
The block sizes supported by the format.
Parameters of the LZ4 frame format.
CompressorInputStream for the framing Snappy format.
CompressorOutputStream for the framing Snappy format.
Dialects of the framing format that FramedSnappyCompressorInputStream can deal with.
Parser/encoder for the "general purpose bit" field in ZIP's local file and central directory headers.
Input stream that decompresses .gz files.
Compressed output stream using the gzip format.
Parameters for the GZIP compressor.
Utility code for the gzip compression format.
 
 
 
 
 
 
Helper class to provide statistics
This interface provides statistics on the current decompression stream.
Supplies input streams.
Invalid Format Exception.
Utility functions
Iterator utilities.
 
Implements an input stream that can read entries from jar files.
Subclass that adds a special extra field to the very first entry which allows the created archive to be used as an executable jar on Solaris.
If this extra field is added as the very first extra field of the archive, Solaris will consider it an executable jar file.
Simple command line application that lists the contents of an archive.
List utilities
 
 
 
 
Helper class for compression algorithms that use the ideas of LZ77.
Represents a back-reference.
Base class representing blocks the compressor may emit.
Enumeration of the block types the compressor may emit.
Callback invoked while the compressor processes data.
A simple "we are done" marker.
Represents a literal block of data.
 
LZMA decompressor.
LZMA compressor.
 
Utility code for the lzma compression format.
 
Generic LZW implementation.
 
 
 
If a stream checks for estimated memory allocation, and the estimate goes above the memory limit, this is thrown.
Read-Only Implementation of SeekableByteChannel that concatenates a collection of other SeekableByteChannels.
 
A ZipEncoding, which uses a java.nio Charset to encode names.
Utilities for dealing with OSGi environments.
Creates a zip in parallel by using multiple threadlocal ScatterZipOutputStream instances.
 
Parameters of the compressor.
Builder for Parameters instances.
Exception thrown when trying to read an encrypted entry or file without configuring a password.
Base class for all PKWare strong crypto extra headers.
Encryption algorithm.
Hash Algorithm
A pure-java implementation of the CRC32 checksum that uses the CRC32-C polynomial, the same polynomial used by iSCSI and implemented on many Intel chipsets supporting SSE4.2.
Random numbers for both the compress and decompress BZip2 classes.
An extra field who's sole purpose is to align and pad the local file header so that the entry's data starts at a certain position.
Store intermediate payload in a scatter-gather scenario.
Supplies ScatterGatherBackingStore instances.
Provides information about a scatter compression run.
A zip output stream that is optimized for multi-threaded scatter/gather construction of zip files.
 
 
A SeekableByteChannel implementation that wraps a byte[].
Iterates all services for a given class through the standard ServiceLoader mechanism.
Set utilities
An entry in a 7z archive.
Reads a 7z file, using SeekableByteChannel under the covers.
 
Collects options for reading 7z archives.
Mutable builder for the immutable SevenZFileOptions.
The (partially) supported compression/encryption methods used in 7z archives.
Combines a SevenZMethod with configuration options for the method.
Writes a 7z file.
Short File Exception.
A wrapper that overwrites SkipShieldingInputStream.skip(long) and delegates to FilterInputStream.read() instead.
CompressorInputStream for the raw Snappy format.
 
CompressorOutputStream for the raw Snappy format.
 
Encapsulates a Deflater and crc calculator, handling multiple types of output streams.
 
 
 
 
Exception thrown by ArchiveStreamFactory if a format is requested/detected that doesn't support streaming.
 
 
Filter stream that mimics a physical tape drive capable of compressing the data stream.
This class represents an entry in a Tar archive.
The TarInputStream reads a UNIX tar archive as an InputStream.
The TarOutputStream writes a UNIX tar archive as an OutputStream.
This class represents a sparse entry in a Tar archive.
This is an inputstream that always return 0, this is used when reading the "holes" of a sparse file
This class represents struct sparse in a Tar archive.
This interface contains all the definitions used in the package.
The TarFile provides random access to UNIX archives.
This class provides static utility methods to work with byte streams.
Info-ZIP Unicode Comment Extra Field (0x6375):
Info-ZIP Unicode Path Extra Field (0x7075):
Constants from stat.h on Unix systems.
Handles extra field data that doesn't follow the recommended pattern for extra fields with a two-byte key and a two-byte length.
Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
Simple placeholder for all those extra fields we don't want to deal with.
Unrecognized Format Exception.
Input stream that decompresses ZIP method 1 (unshrinking).
Unsupported compression algorithm.
Exception thrown when attempting to read or write data for a zip entry that uses ZIP features not supported by this library.
ZIP Features that may or may not be supported.
NTFS extra field that was thought to store various attributes but in reality only stores timestamps.
PKCS#7 Store for X.509 Certificates (0x0014).
X.509 Certificate ID and Signature for individual file (0x0015).
X.509 Certificate ID and Signature for central directory (0x0016).
Strong Encryption Header (0x0017).
PKCS#7 Encryption Recipient Certificate List (0x0019).
An extra field that stores additional file and directory timestamp data for zip entries.
An extra field that stores UNIX UID/GID data (owner & group ownership) for a given zip entry.
Implementation of the xxhash32 hash algorithm.
XZ decompressor.
XZ compressor.
Utility code for the xz compression format.
 
Input stream that decompresses .Z files.
Holds size and other extended information for entries that use Zip64 features.
The different modes ZipArchiveOutputStream can operate in.
Exception thrown when attempting to write data that requires Zip64 support to an archive and UseZip64 has been set to Never.
Extension that adds better handling of extra fields and provides access to the internal and external file attributes.
Indicates how the comment of this entry has been determined.
How to try to parse the extra fields.
Indicates how the name of this entry has been determined.
A predicate to test if a #ZipArchiveEntry matches a criteria.
A Thread-safe representation of a ZipArchiveEntry that is used to add entries to parallel archives.
Implements an input stream that can read Zip archives.
Structure collecting information for the entry that is currently being read.
Reimplementation of java.util.zip.ZipOutputStream that does handle the extended functionality of this package, especially internal/external file attributes and extra fields with different layouts for local file data and central directory entries.
Structure collecting information for the entry that is currently being written.
 
enum that represents the possible policies for creating Unicode extra fields.
Various constants used throughout the package.
Utility class that represents an eight byte integer with conversion rules for the little endian byte order of ZIP files.
An interface for encoders that do a pretty encoding of ZIP file names.
Static helper functions for robustly encoding file names in zip files.
General format of extra field data.
Replacement for java.util.ZipFile.
Extends ZipArchiveEntry to store the offset within the archive.
 
 
Utility class that represents a four byte integer with conversion rules for the little endian byte order of ZIP files.
List of known compression methods Many of these methods are currently not supported by commons compress
Utility class that represents a two byte integer with conversion rules for the little endian byte order of ZIP files.
Used internally by ZipArchiveOutputStream when creating a split archive.
MultiReadOnlySeekableByteChannel that knows what a split ZIP archive should look like.
 
Utility class for handling DOS and Java time conversions.