Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Enum Class SortedBinaryDocValues.Sparsity

java.lang.Object

java.lang.Enum<SortedBinaryDocValues.Sparsity>

org.elasticsearch.index.fielddata.SortedBinaryDocValues.Sparsity

All Implemented Interfaces:

Serializable, Comparable<SortedBinaryDocValues.Sparsity>, Constable

Enclosing class:

SortedBinaryDocValues

public static enum SortedBinaryDocValues.Sparsity
extends Enum<SortedBinaryDocValues.Sparsity>

Describes the sparsity of the values for a field.

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
DENSE	All documents have at least one value for a field.
SPARSE	Not all documents have a value for a field.
UNKNOWN	The sparsity is unknown.

Method Summary

Modifier and Type	Method	Description
static SortedBinaryDocValues.Sparsity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortedBinaryDocValues.Sparsity[]	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

SPARSE

public static final SortedBinaryDocValues.Sparsity SPARSE

Not all documents have a value for a field.

DENSE

public static final SortedBinaryDocValues.Sparsity DENSE

All documents have at least one value for a field.

UNKNOWN

public static final SortedBinaryDocValues.Sparsity UNKNOWN

The sparsity is unknown.

Method Details

values

public static SortedBinaryDocValues.Sparsity[] 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 SortedBinaryDocValues.Sparsity 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