Module org.apache.arrow.compression

Package org.apache.arrow.compression

Class ZstdCompressionCodec

java.lang.Object

org.apache.arrow.vector.compression.AbstractCompressionCodec

org.apache.arrow.compression.ZstdCompressionCodec

All Implemented Interfaces:

CompressionCodec

public class ZstdCompressionCodec
extends AbstractCompressionCodec

Compression codec for the ZSTD algorithm.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.vector.compression.CompressionCodec

CompressionCodec.Factory

Constructor Summary

Constructors

Constructor	Description
ZstdCompressionCodec()
ZstdCompressionCodec(int compressionLevel)

Method Summary

Modifier and Type	Method	Description
protected ArrowBuf	doCompress(BufferAllocator allocator, ArrowBuf uncompressedBuffer)	The method that actually performs the data compression.
protected ArrowBuf	doDecompress(BufferAllocator allocator, ArrowBuf compressedBuffer)	The method that actually performs the data decompression.
CompressionUtil.CodecType	getCodecType()	Gets the type of the codec.

Methods inherited from class org.apache.arrow.vector.compression.AbstractCompressionCodec

compress, decompress, readUncompressedLength, writeUncompressedLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ZstdCompressionCodec

public ZstdCompressionCodec()

ZstdCompressionCodec

public ZstdCompressionCodec(int compressionLevel)

Method Details

doCompress

protected ArrowBuf doCompress(BufferAllocator allocator,
 ArrowBuf uncompressedBuffer)

Description copied from class: AbstractCompressionCodec

The method that actually performs the data compression. The layout of the returned compressed buffer is the compressed data, plus 8 bytes reserved at the beginning of the buffer for the uncompressed data size.

Please note that this method is not responsible for releasing the uncompressed buffer.

Specified by:

doCompress in class AbstractCompressionCodec

doDecompress

protected ArrowBuf doDecompress(BufferAllocator allocator,
 ArrowBuf compressedBuffer)

Description copied from class: AbstractCompressionCodec

The method that actually performs the data decompression. The layout of the compressed buffer is the compressed data, plus 8 bytes at the beginning of the buffer storing the uncompressed data size.

Please note that this method is not responsible for releasing the compressed buffer.

Specified by:

doDecompress in class AbstractCompressionCodec

getCodecType

public CompressionUtil.CodecType getCodecType()

Description copied from interface: CompressionCodec

Gets the type of the codec.

Returns:

the type of the codec.