org.apache.hudi.io.compress

Enum CompressionCodec

java.lang.Object

java.lang.Enum<CompressionCodec>

org.apache.hudi.io.compress.CompressionCodec

All Implemented Interfaces:

Serializable, Comparable<CompressionCodec>

public enum CompressionCodec
extends Enum<CompressionCodec>

Available compression codecs. There should not be any assumption on the ordering or ordinal of the defined enums.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZIP2
GZIP
LZ4
LZO
NONE
SNAPPY
ZSTD

Method Summary

Modifier and Type	Method and Description
static CompressionCodec	decodeCompressionCodec(int id) Gets the compression codec based on the ID.
static CompressionCodec	findCodecByName(String name)
int	getId()
String	getName()
static CompressionCodec	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompressionCodec[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CompressionCodec NONE

BZIP2

public static final CompressionCodec BZIP2

GZIP

public static final CompressionCodec GZIP

LZ4

public static final CompressionCodec LZ4

LZO

public static final CompressionCodec LZO

SNAPPY

public static final CompressionCodec SNAPPY

ZSTD

public static final CompressionCodec ZSTD

Method Detail

values

public static CompressionCodec[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CompressionCodec c : CompressionCodec.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CompressionCodec valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

getId

public int getId()

findCodecByName

public static CompressionCodec findCodecByName(String name)

decodeCompressionCodec

public static CompressionCodec decodeCompressionCodec(int id)

Gets the compression codec based on the ID. This ID is written to the HFile on storage.

Parameters:

id - ID indicating the compression codec

Returns:

compression codec based on the ID