Top Description Interfaces Classes Enums
[default module]

Package net.jpountz.lz4


LZ4 compression. The entry point of the API is the net.jpountz.lz4.LZ4Factory class, which gives access to compressors and decompressors.

Sample usage:

    LZ4Factory factory = LZ4Factory.fastestInstance();

    byte[] data = "12345345234572".getBytes("UTF-8");
    final int decompressedLength = data.length;

    // compress data
    LZ4Compressor compressor = factory.fastCompressor();
    int maxCompressedLength = compressor.maxCompressedLength(decompressedLength);
    byte[] compressed = new byte[maxCompressedLength];
    int compressedLength = compressor.compress(data, 0, decompressedLength, compressed, 0, maxCompressedLength);

    // decompress data
    // - method 1: when the decompressed length is known
    LZ4FastDecompressor decompressor = factory.fastDecompressor();
    byte[] restored = new byte[decompressedLength];
    int compressedLength2 = decompressor.decompress(compressed, 0, restored, 0, decompressedLength);
    // compressedLength == compressedLength2

    // - method 2: when the compressed length is known (a little slower)
    // the destination buffer needs to be over-sized
    LZ4SafeDecompressor decompressor2 = factory.safeDecompressor();
    int decompressedLength2 = decompressor2.decompress(compressed, 0, compressedLength, restored, 0);
    // decompressedLength == decompressedLength2

Interface Summary

Modifier and TypeInterface and Description
public interface
LZ4Decompressor

Deprecated Use LZ4FastDecompressor instead.
public interface

Class Summary

Modifier and TypeClass and Description
public class
LZ4BlockInputStream

InputStream implementation to decode data written with LZ4BlockOutputStream.

public class
LZ4BlockOutputStream

Streaming LZ4.

public abstract class
LZ4Compressor

LZ4 compressor.

public class
LZ4Exception

LZ4 compression or decompression error.

public class
LZ4Factory

Entry point for the LZ4 API.

public abstract class
LZ4FastDecompressor

Deprecated as a consequence of LZ4Decompressor being deprecated.
LZ4 decompressor that requires the size of the original input to be known.
pack-priv class
LZ4HCJNICompressor

High compression LZ4Compressors implemented with JNI bindings to the original C implementation of LZ4.

pack-priv class
LZ4JNICompressor

Fast LZ4FastCompressors implemented with JNI bindings to the original C implementation of LZ4.

pack-priv class
LZ4JNIFastDecompressor

Deprecated as a consequence of LZ4FastDecompressor being deprecated.
LZ4FastDecompressor implemented with JNI bindings to the original C implementation of LZ4.
pack-priv class
LZ4JNISafeDecompressor

Deprecated as a consequence of LZ4SafeDecompressor being deprecated.
LZ4SafeDecompressor implemented with JNI bindings to the original C implementation of LZ4.
public abstract class
LZ4SafeDecompressor

Deprecated as a consequence of LZ4UnknownSizeDecompressor being deprecated.
LZ4 decompressor that requires the size of the compressed data to be known.

Enum Summary

Modifier and TypeEnum and Description
pack-priv enum
pack-priv enum
pack-priv enum
LZ4JNI

JNI bindings to the original C implementation of LZ4.

pack-priv enum
pack-priv enum
pack-priv enum