org.rocksdb

Enum CompressionType

java.lang.Object

java.lang.Enum<CompressionType>

org.rocksdb.CompressionType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CompressionType>

public enum CompressionType
extends java.lang.Enum<CompressionType>

Enum CompressionType

DB contents are stored in a set of blocks, each of which holds a sequence of key,value pairs. Each block may be compressed before being stored in a file. The following enum describes which compression method (if any) is used to compress a block.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZLIB2_COMPRESSION
LZ4_COMPRESSION
LZ4HC_COMPRESSION
NO_COMPRESSION
SNAPPY_COMPRESSION
ZLIB_COMPRESSION

Method Summary

Methods

Modifier and Type	Method and Description
static CompressionType	getCompressionType(byte byteIdentifier) Get the CompressionType enumeration value by passing the byte identifier to this method.
static CompressionType	getCompressionType(java.lang.String libraryName) Get the CompressionType enumeration value by passing the library name to this method.
java.lang.String	getLibraryName() Returns the library name of the compression type identified by the enumeration value.
byte	getValue() Returns the byte value of the enumerations value.
static CompressionType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompressionType[]	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

NO_COMPRESSION

public static final CompressionType NO_COMPRESSION

SNAPPY_COMPRESSION

public static final CompressionType SNAPPY_COMPRESSION

ZLIB_COMPRESSION

public static final CompressionType ZLIB_COMPRESSION

BZLIB2_COMPRESSION

public static final CompressionType BZLIB2_COMPRESSION

LZ4_COMPRESSION

public static final CompressionType LZ4_COMPRESSION

LZ4HC_COMPRESSION

public static final CompressionType LZ4HC_COMPRESSION

Method Detail

values

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

Returns:

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

valueOf

public static CompressionType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getCompressionType

public static CompressionType getCompressionType(java.lang.String libraryName)

Get the CompressionType enumeration value by passing the library name to this method.

If library cannot be found the enumeration value NO_COMPRESSION will be returned.

Parameters:

libraryName - compression library name.

Returns:

CompressionType instance.

getCompressionType

public static CompressionType getCompressionType(byte byteIdentifier)

Get the CompressionType enumeration value by passing the byte identifier to this method.

If library cannot be found the enumeration value NO_COMPRESSION will be returned.

Parameters:

byteIdentifier - of CompressionType.

Returns:

CompressionType instance.

getValue

public byte getValue()

Returns the byte value of the enumerations value.

Returns:

byte representation

getLibraryName

public java.lang.String getLibraryName()

Returns the library name of the compression type identified by the enumeration value.

Returns:

library name