Module org.elasticsearch.server

Package org.elasticsearch.index.codec.tsdb

Enum Class DocOffsetsCodec

java.lang.Object

java.lang.Enum<DocOffsetsCodec>

org.elasticsearch.index.codec.tsdb.DocOffsetsCodec

All Implemented Interfaces:

Serializable, Comparable<DocOffsetsCodec>, Constable

public enum DocOffsetsCodec
extends Enum<DocOffsetsCodec>

Represents a codec for encoding and decoding document offsets. Each codec defines custom strategies for compression and decompression of document offsets for compressed binary doc values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocOffsetsCodec.Decoder	A decoder to decode the format on disk to doc offsets.
static interface	DocOffsetsCodec.Encoder	An encoder to store doc offsets in a more space-efficient format for storage.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BITPACKING	A codec that uses delta encoding and bit-packing for storage of document offsets.
GROUPED_VINT	A codec that uses grouped VInts for storage of document offsets.

Method Summary

Modifier and Type	Method	Description
abstract DocOffsetsCodec.Decoder	getDecoder()
abstract DocOffsetsCodec.Encoder	getEncoder()
static DocOffsetsCodec	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocOffsetsCodec[]	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

BITPACKING

public static final DocOffsetsCodec BITPACKING

A codec that uses delta encoding and bit-packing for storage of document offsets.

GROUPED_VINT

public static final DocOffsetsCodec GROUPED_VINT

A codec that uses grouped VInts for storage of document offsets.

Method Details

values

public static DocOffsetsCodec[] 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 DocOffsetsCodec 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

getEncoder

public abstract DocOffsetsCodec.Encoder getEncoder()

getDecoder

public abstract DocOffsetsCodec.Decoder getDecoder()