Package org.apache.hadoop.hbase.io.compress

Enum Class Compression.Algorithm

java.lang.Object

java.lang.Enum<Compression.Algorithm>

org.apache.hadoop.hbase.io.compress.Compression.Algorithm

All Implemented Interfaces:

Serializable, Comparable<Compression.Algorithm>, Constable

Enclosing class:

Compression

@Public
public static enum Compression.Algorithm
extends Enum<Compression.Algorithm>

Compression algorithms. The ordinal of these cannot change or else you risk breaking all existing HFiles out there. Even the ones that are not compressed! (They use the NONE algorithm)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BROTLI
BZIP2
GZ
LZ4
LZMA
LZO
NONE
SNAPPY
ZSTD

Field Summary

Fields

Modifier and Type	Field	Description
private final String	compressName
private final org.apache.hadoop.conf.Configuration	conf
private final String	confDefault
private final String	confKey
private static final int	DATA_IBUF_SIZE	data input buffer size to absorb small reads from application.
private static final int	DATA_OBUF_SIZE	data output buffer size to absorb small writes from application.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Algorithm(String name, String confKey, String confDefault)

Method Summary

Modifier and Type	Method	Description
OutputStream	createCompressionStream(OutputStream downStream, org.apache.hadoop.io.compress.Compressor compressor, int downStreamBufferSize)
InputStream	createDecompressionStream(InputStream downStream, org.apache.hadoop.io.compress.Decompressor decompressor, int downStreamBufferSize)
org.apache.hadoop.io.compress.CompressionOutputStream	createPlainCompressionStream(OutputStream downStream, org.apache.hadoop.io.compress.Compressor compressor)	Creates a compression stream without any additional wrapping into buffering streams.
(package private) abstract org.apache.hadoop.io.compress.CompressionCodec	getCodec(org.apache.hadoop.conf.Configuration conf)
org.apache.hadoop.io.compress.Compressor	getCompressor()
org.apache.hadoop.io.compress.Decompressor	getDecompressor()
String	getName()
abstract org.apache.hadoop.io.compress.CompressionCodec	reload(org.apache.hadoop.conf.Configuration conf)	Reload configuration for the given algorithm.
void	returnCompressor(org.apache.hadoop.io.compress.Compressor compressor)
void	returnDecompressor(org.apache.hadoop.io.compress.Decompressor decompressor)
static Compression.Algorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Compression.Algorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LZO

public static final Compression.Algorithm LZO

GZ

public static final Compression.Algorithm GZ

NONE

public static final Compression.Algorithm NONE

SNAPPY

public static final Compression.Algorithm SNAPPY

LZ4

public static final Compression.Algorithm LZ4

BZIP2

public static final Compression.Algorithm BZIP2

ZSTD

public static final Compression.Algorithm ZSTD

LZMA

public static final Compression.Algorithm LZMA

BROTLI

public static final Compression.Algorithm BROTLI

Field Details

conf

private final org.apache.hadoop.conf.Configuration conf

compressName

private final String compressName

confKey

private final String confKey

confDefault

private final String confDefault

DATA_IBUF_SIZE

private static final int DATA_IBUF_SIZE

data input buffer size to absorb small reads from application.

See Also:

• Constant Field Values

DATA_OBUF_SIZE

private static final int DATA_OBUF_SIZE

data output buffer size to absorb small writes from application.

See Also:

• Constant Field Values

Constructor Details

Algorithm

private Algorithm(String name,
 String confKey,
 String confDefault)

Method Details

values

public static Compression.Algorithm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Compression.Algorithm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCodec

abstract org.apache.hadoop.io.compress.CompressionCodec getCodec(org.apache.hadoop.conf.Configuration conf)

reload

public abstract org.apache.hadoop.io.compress.CompressionCodec reload(org.apache.hadoop.conf.Configuration conf)

Reload configuration for the given algorithm.

NOTE: Experts only. This can only be done safely during process startup, before the algorithm's codecs are in use. If the codec implementation is changed, the new implementation may not be fully compatible with what was loaded at static initialization time, leading to potential data corruption. Mostly used by unit tests.

Parameters:

conf - configuration

createDecompressionStream

public InputStream createDecompressionStream(InputStream downStream,
 org.apache.hadoop.io.compress.Decompressor decompressor,
 int downStreamBufferSize)
                                      throws IOException

Throws:

IOException

createCompressionStream

public OutputStream createCompressionStream(OutputStream downStream,
 org.apache.hadoop.io.compress.Compressor compressor,
 int downStreamBufferSize)
                                     throws IOException

Throws:

IOException

createPlainCompressionStream

public org.apache.hadoop.io.compress.CompressionOutputStream createPlainCompressionStream(OutputStream downStream,
 org.apache.hadoop.io.compress.Compressor compressor)
                                                                                   throws IOException

Creates a compression stream without any additional wrapping into buffering streams.

Throws:

IOException

getCompressor

public org.apache.hadoop.io.compress.Compressor getCompressor()

returnCompressor

public void returnCompressor(org.apache.hadoop.io.compress.Compressor compressor)

getDecompressor

public org.apache.hadoop.io.compress.Decompressor getDecompressor()

returnDecompressor

public void returnDecompressor(org.apache.hadoop.io.compress.Decompressor decompressor)

getName

public String getName()