org.apache.paimon.types

Enum DataTypeRoot

java.lang.Object

java.lang.Enum<DataTypeRoot>

org.apache.paimon.types.DataTypeRoot

All Implemented Interfaces:

Serializable, Comparable<DataTypeRoot>

@Public
public enum DataTypeRoot
extends Enum<DataTypeRoot>

An enumeration of Data type roots containing static information about logical data types.

A root is an essential description of a DataType without additional parameters. For example, a parameterized Data type DECIMAL(12,3) possesses all characteristics of its root DECIMAL. Additionally, a Data type root enables efficient comparison during the evaluation of types.

See the type-implementing classes for a more detailed description of each type.

Note to implementers: Whenever we perform a match against a type root (e.g. using a switch/case statement), it is recommended to:

• Order the items by the type root definition in this class for easy readability.
• Think about the behavior of all type roots for the implementation. A default fallback is dangerous when introducing a new type root in the future.

Since:

0.4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY
BIGINT
BINARY
BOOLEAN
CHAR
DATE
DECIMAL
DOUBLE
FLOAT
INTEGER
MAP
MULTISET
ROW
SMALLINT
TIME_WITHOUT_TIME_ZONE
TIMESTAMP_WITH_LOCAL_TIME_ZONE
TIMESTAMP_WITHOUT_TIME_ZONE
TINYINT
VARBINARY
VARCHAR

Method Summary

Modifier and Type	Method and Description
Set<DataTypeFamily>	getFamilies()
static DataTypeRoot	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataTypeRoot[]	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

CHAR

public static final DataTypeRoot CHAR

VARCHAR

public static final DataTypeRoot VARCHAR

BOOLEAN

public static final DataTypeRoot BOOLEAN

BINARY

public static final DataTypeRoot BINARY

VARBINARY

public static final DataTypeRoot VARBINARY

DECIMAL

public static final DataTypeRoot DECIMAL

TINYINT

public static final DataTypeRoot TINYINT

SMALLINT

public static final DataTypeRoot SMALLINT

INTEGER

public static final DataTypeRoot INTEGER

BIGINT

public static final DataTypeRoot BIGINT

FLOAT

public static final DataTypeRoot FLOAT

DOUBLE

public static final DataTypeRoot DOUBLE

DATE

public static final DataTypeRoot DATE

TIME_WITHOUT_TIME_ZONE

public static final DataTypeRoot TIME_WITHOUT_TIME_ZONE

TIMESTAMP_WITHOUT_TIME_ZONE

public static final DataTypeRoot TIMESTAMP_WITHOUT_TIME_ZONE

TIMESTAMP_WITH_LOCAL_TIME_ZONE

public static final DataTypeRoot TIMESTAMP_WITH_LOCAL_TIME_ZONE

ARRAY

public static final DataTypeRoot ARRAY

MULTISET

public static final DataTypeRoot MULTISET

MAP

public static final DataTypeRoot MAP

ROW

public static final DataTypeRoot ROW

Method Detail

values

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

Returns:

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

valueOf

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

getFamilies

public Set<DataTypeFamily> getFamilies()