Package org.apache.lucene.codecs.blocktree

Enum CompressionAlgorithm

java.lang.Object

java.lang.Enum<CompressionAlgorithm>

org.apache.lucene.codecs.blocktree.CompressionAlgorithm

All Implemented Interfaces:

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

enum CompressionAlgorithm
extends java.lang.Enum<CompressionAlgorithm>

Compression algorithm used for suffixes of a block of terms.

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOWERCASE_ASCII
LZ4
NO_COMPRESSION

Field Summary

Fields

Modifier and Type	Field	Description
private static CompressionAlgorithm[]	BY_CODE
int	code

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompressionAlgorithm(int code)

Method Summary

Modifier and Type	Method	Description
(package private) static CompressionAlgorithm	byCode(int code)	Look up a CompressionAlgorithm by its code.
(package private) abstract void	read(DataInput in, byte[] out, int len)
static CompressionAlgorithm	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CompressionAlgorithm[]	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 CompressionAlgorithm NO_COMPRESSION

LOWERCASE_ASCII

public static final CompressionAlgorithm LOWERCASE_ASCII

LZ4

public static final CompressionAlgorithm LZ4

Field Detail

BY_CODE

private static final CompressionAlgorithm[] BY_CODE

code

public final int code

Constructor Detail

CompressionAlgorithm

private CompressionAlgorithm(int code)

Method Detail

values

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

Returns:

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

valueOf

public static CompressionAlgorithm 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

byCode

static final CompressionAlgorithm byCode(int code)

Look up a CompressionAlgorithm by its code.

read

abstract void read(DataInput in,
                   byte[] out,
                   int len)
            throws java.io.IOException

Throws:

java.io.IOException