Package org.apache.arrow.vector

Enum BufferLayout.BufferType

java.lang.Object

java.lang.Enum<BufferLayout.BufferType>

org.apache.arrow.vector.BufferLayout.BufferType

All Implemented Interfaces:

Serializable, Comparable<BufferLayout.BufferType>, java.lang.constant.Constable

Enclosing class:

BufferLayout

public static enum BufferLayout.BufferType
extends Enum<BufferLayout.BufferType>

Enumeration of the different logical types a buffer can have. Data buffer is common to most of the layouts. Offset buffer is used for variable width types. Validity buffer is used for nullable types. Type buffer is used for Union types. Size buffer is used for ListView and LargeListView types.

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
DATA
OFFSET
SIZE
TYPE
VALIDITY
VARIADIC_DATA_BUFFERS
VIEWS

Method Summary

Modifier and Type	Method	Description
String	getName()
static BufferLayout.BufferType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BufferLayout.BufferType[]	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, 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

DATA

public static final BufferLayout.BufferType DATA

OFFSET

public static final BufferLayout.BufferType OFFSET

VALIDITY

public static final BufferLayout.BufferType VALIDITY

TYPE

public static final BufferLayout.BufferType TYPE

SIZE

public static final BufferLayout.BufferType SIZE

VIEWS

public static final BufferLayout.BufferType VIEWS

VARIADIC_DATA_BUFFERS

public static final BufferLayout.BufferType VARIADIC_DATA_BUFFERS

Method Details

values

public static BufferLayout.BufferType[] values()

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

Returns:

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

valueOf

public static BufferLayout.BufferType valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()