org.apache.hadoop.hbase.io.compress

Enum 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>

Enclosing class:

Compression

@InterfaceAudience.Public
 @InterfaceStability.Evolving
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)

Enum Constant Summary

Enum Constants

Enum Constant and Description
GZ
LZ4
LZO
NONE
SNAPPY

Method Summary

Modifier and Type	Method and Description
OutputStream	createCompressionStream(OutputStream downStream, Compressor compressor, int downStreamBufferSize)
InputStream	createDecompressionStream(InputStream downStream, Decompressor decompressor, int downStreamBufferSize)
CompressionOutputStream	createPlainCompressionStream(OutputStream downStream, Compressor compressor) Creates a compression stream without any additional wrapping into buffering streams.
Compressor	getCompressor()
Decompressor	getDecompressor()
String	getName()
void	returnCompressor(Compressor compressor)
void	returnDecompressor(Decompressor decompressor)
static Compression.Algorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compression.Algorithm[]	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

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

Method Detail

values

public static Compression.Algorithm[] 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 (Compression.Algorithm c : Compression.Algorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static Compression.Algorithm 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

createDecompressionStream

public InputStream createDecompressionStream(InputStream downStream,
                                             Decompressor decompressor,
                                             int downStreamBufferSize)
                                      throws IOException

Throws:

IOException

createCompressionStream

public OutputStream createCompressionStream(OutputStream downStream,
                                            Compressor compressor,
                                            int downStreamBufferSize)
                                     throws IOException

Throws:

IOException

createPlainCompressionStream

public CompressionOutputStream createPlainCompressionStream(OutputStream downStream,
                                                            Compressor compressor)
                                                     throws IOException

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

Throws:

IOException

getCompressor

public Compressor getCompressor()

returnCompressor

public void returnCompressor(Compressor compressor)

getDecompressor

public Decompressor getDecompressor()

returnDecompressor

public void returnDecompressor(Decompressor decompressor)

getName

public String getName()