Package org.apache.hadoop.io.compress

Class ZStandardCodec

java.lang.Object

org.apache.hadoop.io.compress.ZStandardCodec

All Implemented Interfaces:

Configurable, CompressionCodec, DirectDecompressionCodec

public class ZStandardCodec
extends java.lang.Object
implements Configurable, CompressionCodec, DirectDecompressionCodec

This class creates zstd compressors/decompressors.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.io.compress.CompressionCodec

CompressionCodec.Util

Constructor Summary

Constructors

Constructor	Description
ZStandardCodec()

Method Summary

Modifier and Type	Method	Description
static void	checkNativeCodeLoaded()
Compressor	createCompressor()	Create a new Compressor for use by this CompressionCodec.
Decompressor	createDecompressor()	Create a new Decompressor for use by this CompressionCodec.
DirectDecompressor	createDirectDecompressor()	Create a new DirectDecompressor for use by this DirectDecompressionCodec.
CompressionInputStream	createInputStream(java.io.InputStream in)	Create a CompressionInputStream that will read from the given input stream.
CompressionInputStream	createInputStream(java.io.InputStream in, Decompressor decompressor)	Create a CompressionInputStream that will read from the given InputStream with the given Decompressor.
CompressionOutputStream	createOutputStream(java.io.OutputStream out)	Create a CompressionOutputStream that will write to the given OutputStream.
CompressionOutputStream	createOutputStream(java.io.OutputStream out, Compressor compressor)	Create a CompressionOutputStream that will write to the given OutputStream with the given Compressor.
static int	getCompressionBufferSize(Configuration conf)
static int	getCompressionLevel(Configuration conf)
java.lang.Class<? extends Compressor>	getCompressorType()	Get the type of Compressor needed by this CompressionCodec.
Configuration	getConf()	Return the configuration used by this object.
static int	getDecompressionBufferSize(Configuration conf)
java.lang.Class<? extends Decompressor>	getDecompressorType()	Get the type of Decompressor needed by this CompressionCodec.
java.lang.String	getDefaultExtension()	Get the default filename extension for this kind of compression.
static java.lang.String	getLibraryName()
static boolean	isNativeCodeLoaded()
void	setConf(Configuration conf)	Set the configuration to be used by this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZStandardCodec

public ZStandardCodec()

Method Detail

setConf

public void setConf(Configuration conf)

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Parameters:

conf - the configuration object.

getConf

public Configuration getConf()

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

Returns:

the configuration object used by this object.

checkNativeCodeLoaded

public static void checkNativeCodeLoaded()

isNativeCodeLoaded

public static boolean isNativeCodeLoaded()

getLibraryName

public static java.lang.String getLibraryName()

getCompressionLevel

public static int getCompressionLevel(Configuration conf)

getCompressionBufferSize

public static int getCompressionBufferSize(Configuration conf)

getDecompressionBufferSize

public static int getDecompressionBufferSize(Configuration conf)

createOutputStream

public CompressionOutputStream createOutputStream(java.io.OutputStream out)
                                           throws java.io.IOException

Create a CompressionOutputStream that will write to the given OutputStream.

Specified by:

createOutputStream in interface CompressionCodec

Parameters:

out - the location for the final output stream

Returns:

a stream the user can write uncompressed data to have compressed

Throws:

java.io.IOException - raised on errors performing I/O.

createOutputStream

public CompressionOutputStream createOutputStream(java.io.OutputStream out,
                                                  Compressor compressor)
                                           throws java.io.IOException

Create a CompressionOutputStream that will write to the given OutputStream with the given Compressor.

Specified by:

createOutputStream in interface CompressionCodec

Parameters:

out - the location for the final output stream

compressor - compressor to use

Returns:

a stream the user can write uncompressed data to have compressed

Throws:

java.io.IOException - raised on errors performing I/O.

getCompressorType

public java.lang.Class<? extends Compressor> getCompressorType()

Get the type of Compressor needed by this CompressionCodec.

Specified by:

getCompressorType in interface CompressionCodec

Returns:

the type of compressor needed by this codec.

createCompressor

public Compressor createCompressor()

Create a new Compressor for use by this CompressionCodec.

Specified by:

createCompressor in interface CompressionCodec

Returns:

a new compressor for use by this codec

createInputStream

public CompressionInputStream createInputStream(java.io.InputStream in)
                                         throws java.io.IOException

Create a CompressionInputStream that will read from the given input stream.

Specified by:

createInputStream in interface CompressionCodec

Parameters:

in - the stream to read compressed bytes from

Returns:

a stream to read uncompressed bytes from

Throws:

java.io.IOException - raised on errors performing I/O.

createInputStream

public CompressionInputStream createInputStream(java.io.InputStream in,
                                                Decompressor decompressor)
                                         throws java.io.IOException

Create a CompressionInputStream that will read from the given InputStream with the given Decompressor.

Specified by:

createInputStream in interface CompressionCodec

Parameters:

in - the stream to read compressed bytes from

decompressor - decompressor to use

Returns:

a stream to read uncompressed bytes from

Throws:

java.io.IOException - raised on errors performing I/O.

getDecompressorType

public java.lang.Class<? extends Decompressor> getDecompressorType()

Get the type of Decompressor needed by this CompressionCodec.

Specified by:

getDecompressorType in interface CompressionCodec

Returns:

the type of decompressor needed by this codec.

createDecompressor

public Decompressor createDecompressor()

Create a new Decompressor for use by this CompressionCodec.

Specified by:

createDecompressor in interface CompressionCodec

Returns:

a new decompressor for use by this codec

getDefaultExtension

public java.lang.String getDefaultExtension()

Get the default filename extension for this kind of compression.

Specified by:

getDefaultExtension in interface CompressionCodec

Returns:

.zst.

createDirectDecompressor

public DirectDecompressor createDirectDecompressor()

Description copied from interface: DirectDecompressionCodec

Create a new DirectDecompressor for use by this DirectDecompressionCodec.

Specified by:

createDirectDecompressor in interface DirectDecompressionCodec

Returns:

a new direct decompressor for use by this codec