org.apache.arrow.vector.compression

Interface CompressionCodec

All Known Implementing Classes:

AbstractCompressionCodec, Lz4CompressionCodec, NoCompressionCodec, ZstdCompressionCodec

public interface CompressionCodec

The codec for compression/decompression.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CompressionCodec.Factory Factory to create compression codec.

Method Summary

Modifier and Type	Method and Description
ArrowBuf	compress(BufferAllocator allocator, ArrowBuf uncompressedBuffer) Compress a buffer.
ArrowBuf	decompress(BufferAllocator allocator, ArrowBuf compressedBuffer) Decompress a buffer.
CompressionUtil.CodecType	getCodecType() Gets the type of the codec.

Method Detail

compress

ArrowBuf compress(BufferAllocator allocator,
                  ArrowBuf uncompressedBuffer)

Compress a buffer.

Parameters:

allocator - the allocator for allocating memory for compressed buffer.

uncompressedBuffer - the buffer to compress. Implementation of this method should take care of releasing this buffer.

Returns:

the compressed buffer

decompress

ArrowBuf decompress(BufferAllocator allocator,
                    ArrowBuf compressedBuffer)

Decompress a buffer.

Parameters:

allocator - the allocator for allocating memory for decompressed buffer.

compressedBuffer - the buffer to be decompressed. Implementation of this method should take care of releasing this buffer.

Returns:

the decompressed buffer.

getCodecType

CompressionUtil.CodecType getCodecType()

Gets the type of the codec.

Returns:

the type of the codec.