com.twitter.distributedlog.io

Interface CompressionCodec

All Known Implementing Classes:

IdentityCompressionCodec, LZ4CompressionCodec

public interface CompressionCodec

Common interface for compression/decompression operations using different compression codecs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompressionCodec.Type Enum specifying the currently supported compression types.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] data, int offset, int length, org.apache.bookkeeper.stats.OpStatsLogger compressionStat) Return the compressed data as a byte array.
byte[]	decompress(byte[] data, int offset, int length, int decompressedSize, org.apache.bookkeeper.stats.OpStatsLogger decompressionStat) Return the decompressed data as a byte array.
byte[]	decompress(byte[] data, int offset, int length, org.apache.bookkeeper.stats.OpStatsLogger decompressionStat) Return the decompressed data as a byte array.

Method Detail

compress

byte[] compress(byte[] data,
              int offset,
              int length,
              org.apache.bookkeeper.stats.OpStatsLogger compressionStat)

Return the compressed data as a byte array.

Parameters:

data - The data to be compressed

offset - The offset in the bytes of data to compress

length - The number of bytes of data to compress

compressionStat - The stat to use for timing the compression operation

Returns:

The compressed data The returned byte array is sized to the length of the compressed data

decompress

byte[] decompress(byte[] data,
                int offset,
                int length,
                org.apache.bookkeeper.stats.OpStatsLogger decompressionStat)

Return the decompressed data as a byte array.

Parameters:

data - The data to be decompressed

offset - The offset in the bytes of data to decompress

length - The number of bytes of data to decompress

decompressionStat - The stat to use for timing the decompression operation

Returns:

The decompressed data

decompress

byte[] decompress(byte[] data,
                int offset,
                int length,
                int decompressedSize,
                org.apache.bookkeeper.stats.OpStatsLogger decompressionStat)

Return the decompressed data as a byte array.

Parameters:

data - The data to the decompressed

offset - The offset in the bytes of data to decompress

length - The number of bytes of data to decompress

decompressedSize - The exact size of the decompressed data

decompressionStat - The stat to use for timing the decompression operation

Returns:

The decompressed data