Package org.apache.orc.impl

Class ZstdCodec

java.lang.Object

org.apache.orc.impl.ZstdCodec

All Implemented Interfaces:

Closeable, AutoCloseable, CompressionCodec, DirectDecompressionCodec

public class ZstdCodec
extends Object
implements CompressionCodec, DirectDecompressionCodec

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.orc.CompressionCodec

CompressionCodec.DataKind, CompressionCodec.Options, CompressionCodec.SpeedModifier

Constructor Summary

Constructors

Constructor	Description
ZstdCodec()
ZstdCodec(int level, int windowLog, int strategy)

Method Summary

Modifier and Type	Method	Description
void	close()	Return the codec to the pool.
boolean	compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow, CompressionCodec.Options options)	Compresses an input ByteBuffer into an output ByteBuffer using Zstandard compression.
void	decompress(ByteBuffer in, ByteBuffer out)	Decompress the in buffer to the out buffer.
void	destroy()	Closes the codec, releasing the resources.
void	directDecompress(ByteBuffer in, ByteBuffer out)
protected static byte[]	getBuffer(int size)
CompressionCodec.Options	getDefaultOptions()	Get the default options for this codec.
CompressionKind	getKind()	Get the compression kind.
org.apache.orc.impl.ZstdCodec.ZstdOptions	getZstdOptions()
boolean	isAvailable()
void	reset()	Resets the codec, preparing it for reuse.

Methods inherited from class java.lang.Object

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

Constructor Details

ZstdCodec

public ZstdCodec(int level,
 int windowLog,
 int strategy)

ZstdCodec

public ZstdCodec()

Method Details

getZstdOptions

public org.apache.orc.impl.ZstdCodec.ZstdOptions getZstdOptions()

getBuffer

protected static byte[] getBuffer(int size)

getDefaultOptions

public CompressionCodec.Options getDefaultOptions()

Description copied from interface: CompressionCodec

Get the default options for this codec.

Specified by:

getDefaultOptions in interface CompressionCodec

Returns:

the default options object

compress

public boolean compress(ByteBuffer in,
 ByteBuffer out,
 ByteBuffer overflow,
 CompressionCodec.Options options)
                 throws IOException

Compresses an input ByteBuffer into an output ByteBuffer using Zstandard compression. If the maximum bound of the number of output bytes exceeds the output ByteBuffer size, the remaining bytes are written to the overflow ByteBuffer.

Specified by:

compress in interface CompressionCodec

Parameters:

in - the bytes to compress

out - the compressed bytes

overflow - put any additional bytes here

options - the options to control compression

Returns:

true if input data is compressed. Otherwise, false.

Throws:

IOException

decompress

public void decompress(ByteBuffer in,
 ByteBuffer out)
                throws IOException

Description copied from interface: CompressionCodec

Decompress the in buffer to the out buffer.

Specified by:

decompress in interface CompressionCodec

Parameters:

in - the bytes to decompress

out - the decompressed bytes

Throws:

IOException

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface DirectDecompressionCodec

directDecompress

public void directDecompress(ByteBuffer in,
 ByteBuffer out)
                      throws IOException

Specified by:

directDecompress in interface DirectDecompressionCodec

Throws:

IOException

reset

public void reset()

Description copied from interface: CompressionCodec

Resets the codec, preparing it for reuse.

Specified by:

reset in interface CompressionCodec

destroy

public void destroy()

Description copied from interface: CompressionCodec

Closes the codec, releasing the resources.

Specified by:

destroy in interface CompressionCodec

getKind

public CompressionKind getKind()

Description copied from interface: CompressionCodec

Get the compression kind.

Specified by:

getKind in interface CompressionCodec

close

public void close()

Description copied from interface: CompressionCodec

Return the codec to the pool.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CompressionCodec