XZ for Java 1.9 · org.tukaani.xz

XZ data compression support.

Introduction

This aims to be a complete implementation of XZ data compression in pure Java. Features:

Full support for the .xz file format specification version 1.0.4
Single-threaded streamed compression and decompression
Single-threaded decompression with limited random access support
Raw streams (no .xz headers) for advanced users, including LZMA2 with preset dictionary

Threading is planned but it is unknown when it will be implemented.

For the latest source code, see the home page of XZ for Java.

Getting started

Start by reading the documentation of org.tukaani.xz.XZOutputStream and org.tukaani.xz.XZInputStream. If you use XZ inside another file format or protocol, see also org.tukaani.xz.SingleXZInputStream.

Licensing

XZ for Java has been put into the public domain, thus you can do whatever you want with it. All the files in the package have been written by Lasse Collin, Igor Pavlov, and/or Brett Okken.

This software is provided "as is", without any warranty.

Modifier and Type	Interface and Description
pack-priv interface	FilterCoder
pack-priv interface	FilterDecoder
pack-priv interface	FilterEncoder

Class Summary

Modifier and Type	Class and Description
public class	ARMOptions BCJ filter for little endian ARM instructions.
public class	ARMThumbOptions BCJ filter for little endian ARM-Thumb instructions.
public class	ArrayCache Caches large arrays for reuse (base class and a dummy cache implementation).
public class	BasicArrayCache A basic `ArrayCache` implementation.
pack-priv abstract class	BCJCoder
pack-priv class	BCJDecoder
pack-priv class	BCJEncoder
pack-priv abstract class	BCJOptions
pack-priv class	BlockInputStream
pack-priv class	BlockOutputStream
public class	CloseIgnoringInputStream An `InputStream` wrapper whose `close()` does nothing.
public class	CorruptedInputException Thrown when the compressed input data is corrupt.
pack-priv class	CountingInputStream Counts the number of bytes read from an input stream.
pack-priv class	CountingOutputStream Counts the number of bytes written to an output stream.
pack-priv abstract class	DeltaCoder
pack-priv class	DeltaDecoder
pack-priv class	DeltaEncoder
public class	DeltaInputStream Decodes raw Delta-filtered data (no XZ headers).
public class	DeltaOptions Delta filter options.
pack-priv class	DeltaOutputStream
public abstract class	FilterOptions Base class for filter-specific options classes.
public abstract class	FinishableOutputStream Output stream that supports finishing without closing the underlying stream.
public class	FinishableWrapperOutputStream Wraps an output stream to a finishable output stream for use with raw encoders.
public class	IA64Options BCJ filter for Itanium (IA-64) instructions.
pack-priv class	IndexIndicatorException
pack-priv abstract class	LZMA2Coder
pack-priv class	LZMA2Decoder
pack-priv class	LZMA2Encoder
public class	LZMA2InputStream Decompresses a raw LZMA2 stream (no XZ headers).
public class	LZMA2Options LZMA2 compression options.
pack-priv class	LZMA2OutputStream
public class	LZMAInputStream Decompresses legacy .lzma files and raw LZMA streams (no .lzma header).
public class	LZMAOutputStream Compresses into the legacy .lzma file format or into a raw LZMA stream.
public class	MemoryLimitException Thrown when the memory usage limit given to the XZ decompressor would be exceeded.
public class	PowerPCOptions BCJ filter for big endian PowerPC instructions.
pack-priv class	RawCoder
public class	ResettableArrayCache An ArrayCache wrapper that remembers what has been allocated and allows returning all allocations to the underlying cache at once.
public class	SeekableFileInputStream Wraps a `RandomAccessFile` in a SeekableInputStream.
public abstract class	SeekableInputStream Input stream with random access support.
public class	SeekableXZInputStream Decompresses a .xz file in random access mode.
pack-priv class	SimpleInputStream
pack-priv class	SimpleOutputStream
public class	SingleXZInputStream Decompresses exactly one XZ Stream in streamed mode (no seeking).
public class	SPARCOptions BCJ filter for SPARC.
pack-priv class	UncompressedLZMA2OutputStream
public class	UnsupportedOptionsException Thrown when compression options not supported by this implementation are detected.
public class	X86Options BCJ filter for x86 (32-bit and 64-bit) instructions.
public class	XZ XZ constants.
public class	XZFormatException Thrown when the input data is not in the XZ format.
public class	XZInputStream Decompresses a .xz file in streamed mode (no seeking).
public class	XZIOException Generic `IOException` specific to this package.
public class	XZOutputStream Compresses into the .xz file format.

Package org.tukaani.xz

Introduction

Getting started

Licensing

Interface Summary

Class Summary