org.apache.arrow.vector.compression

Interface CompressionCodec

All Known Implementing Classes:

NoCompressionCodec

public interface CompressionCodec

The codec for compression/decompression.

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.
String	getCodecName() Gets the name 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.

getCodecName

String getCodecName()

Gets the name of the codec.

Returns:

the name of the codec.