Package dev.vortex.api

Enum Class ScanOptions.SelectionMode

java.lang.Object

java.lang.Enum<ScanOptions.SelectionMode>

dev.vortex.api.ScanOptions.SelectionMode

All Implemented Interfaces:

Serializable, Comparable<ScanOptions.SelectionMode>, Constable

Enclosing interface:

ScanOptions

public static enum ScanOptions.SelectionMode
extends Enum<ScanOptions.SelectionMode>

How to interpret the row selection payload.

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
EXCLUDE	Return rows except those at the indices.
EXCLUDE_ROARING	Return rows except those in the Roaring bitmap.
INCLUDE	Return only rows at the indices.
INCLUDE_ALL	Ignore row selection payloads.
INCLUDE_ROARING	Return only rows in the Roaring bitmap.

Method Summary

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

INCLUDE_ALL

public static final ScanOptions.SelectionMode INCLUDE_ALL

Ignore row selection payloads.

INCLUDE

public static final ScanOptions.SelectionMode INCLUDE

Return only rows at the indices.

EXCLUDE

public static final ScanOptions.SelectionMode EXCLUDE

Return rows except those at the indices.

INCLUDE_ROARING

public static final ScanOptions.SelectionMode INCLUDE_ROARING

Return only rows in the Roaring bitmap.

EXCLUDE_ROARING

public static final ScanOptions.SelectionMode EXCLUDE_ROARING

Return rows except those in the Roaring bitmap.

Method Details

values

public static ScanOptions.SelectionMode[] 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 ScanOptions.SelectionMode 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

code

public byte code()