DataType

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArrayType, BooleanType, ByteType, CharType, DateTimeType, DateType, DecimalType, DoubleType, FloatType, IntegerType, LongType, ObjectType, ShortType, StringType, StructType, TimeType
```
public interface DataType
extends java.io.Serializable
```
The interface of data types.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class DataType.ID
Data type ID.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DataType.ID` Data type ID.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.regex.Pattern`	`BooleanPattern` Regex for boolean.
`static java.util.regex.Pattern`	`DatePattern` Regex for date.
`static java.util.regex.Pattern`	`DateTimePattern` Regex for datetime.
`static java.util.regex.Pattern`	`DoublePattern` Regex for double.
`static java.util.regex.Pattern`	`IntPattern` Regex for integer.
`static java.util.regex.Pattern`	`LongPattern` Regex for long.
`static java.util.regex.Pattern`	`TimePattern` Regex for time.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default DataType`	`boxed()` Returns the boxed data type if this is a primitive type.
`static DataType`	`coerce(DataType a, DataType b)` Returns the common type.
`DataType.ID`	`id()` Returns the type ID enum.
`static DataType`	`infer(java.lang.String s)` Infers the type of a string.
`default boolean`	`isBoolean()` Returns true if the type is boolean or Boolean.
`default boolean`	`isByte()` Returns true if the type is byte or Byte.
`default boolean`	`isChar()` Returns true if the type is char or Char.
`default boolean`	`isDouble()` Returns true if the type is double or Double.
`static boolean`	`isDouble(DataType t)` Returns true if the given type is of double, either primitive or boxed.
`default boolean`	`isFloat()` Returns true if the type is float or Float.
`static boolean`	`isFloat(DataType t)` Returns true if the given type is of float, either primitive or boxed.
`default boolean`	`isFloating()` Returns true if the type is float or double.
`default boolean`	`isInt()` Returns true if the type is int or Integer.
`static boolean`	`isInt(DataType t)` Returns true if the given type is of int, short, byte, char, either primitive or boxed.
`default boolean`	`isIntegral()` Returns true if the type is int, long, short or byte.
`default boolean`	`isLong()` Returns true if the type is long or Long.
`static boolean`	`isLong(DataType t)` Returns true if the given type is of long, either primitive or boxed.
`default boolean`	`isNumeric()` Returns true if the type is numeric (integral or floating).
`default boolean`	`isObject()` Returns true if the type is ObjectType.
`default boolean`	`isPrimitive()` Returns true if this is a primitive data type.
`default boolean`	`isShort()` Returns true if the type is short or Shorter.
`default boolean`	`isString()` Returns true if the type is String.
`java.lang.String`	`name()` Returns the type name used in external catalogs.
`static DataType`	`of(java.lang.Class clazz)` Returns the DataType of a class.
`static DataType`	`of(java.sql.JDBCType type, boolean nullable, java.lang.String dbms)` Returns the DataType of a JDBC type.
`static DataType`	`of(java.lang.String s)` Returns a DataType from its string representation.
`static DataType`	`prompt(DataType a, DataType b)` Type promotion when apply to expressions.
`default java.lang.String`	`toString(java.lang.Object o)` Returns the string representation of a value of the type.
`default DataType`	`unboxed()` Returns the unboxed data type if this is a boxed primitive type.
`java.lang.Object`	`valueOf(java.lang.String s)` Returns the value from its string representation.

- Field Detail
  - BooleanPattern
```
static final java.util.regex.Pattern BooleanPattern
```
    Regex for boolean.
  - IntPattern
```
static final java.util.regex.Pattern IntPattern
```
    Regex for integer.
  - LongPattern
```
static final java.util.regex.Pattern LongPattern
```
    Regex for long.
  - DoublePattern
```
static final java.util.regex.Pattern DoublePattern
```
    Regex for double.
  - DatePattern
```
static final java.util.regex.Pattern DatePattern
```
    Regex for date.
  - TimePattern
```
static final java.util.regex.Pattern TimePattern
```
    Regex for time.
  - DateTimePattern
```
static final java.util.regex.Pattern DateTimePattern
```
    Regex for datetime.
- Method Detail
  - name
```
java.lang.String name()
```
    Returns the type name used in external catalogs. DataType.of(name()) should returns the same type.
  - id
```
DataType.ID id()
```
    Returns the type ID enum.
  - valueOf
```
java.lang.Object valueOf(java.lang.String s)
```
    Returns the value from its string representation.
    
    Parameters:
    
    s - the string representation of a value of this type.
  - toString
```
default java.lang.String toString(java.lang.Object o)
```
    Returns the string representation of a value of the type.
  - isPrimitive
```
default boolean isPrimitive()
```
    Returns true if this is a primitive data type.
  - isFloating
```
default boolean isFloating()
```
    Returns true if the type is float or double.
  - isIntegral
```
default boolean isIntegral()
```
    Returns true if the type is int, long, short or byte.
  - isNumeric
```
default boolean isNumeric()
```
    Returns true if the type is numeric (integral or floating).
  - isBoolean
```
default boolean isBoolean()
```
    Returns true if the type is boolean or Boolean.
  - isChar
```
default boolean isChar()
```
    Returns true if the type is char or Char.
  - isByte
```
default boolean isByte()
```
    Returns true if the type is byte or Byte.
  - isShort
```
default boolean isShort()
```
    Returns true if the type is short or Shorter.
  - isInt
```
default boolean isInt()
```
    Returns true if the type is int or Integer.
  - isLong
```
default boolean isLong()
```
    Returns true if the type is long or Long.
  - isFloat
```
default boolean isFloat()
```
    Returns true if the type is float or Float.
  - isDouble
```
default boolean isDouble()
```
    Returns true if the type is double or Double.
  - isString
```
default boolean isString()
```
    Returns true if the type is String.
  - isObject
```
default boolean isObject()
```
    Returns true if the type is ObjectType.
  - boxed
```
default DataType boxed()
```
    Returns the boxed data type if this is a primitive type. Otherwise, return this type.
  - unboxed
```
default DataType unboxed()
```
    Returns the unboxed data type if this is a boxed primitive type. Otherwise, return this type.
  - infer
```
static DataType infer(java.lang.String s)
```
    Infers the type of a string.
  - of
```
static DataType of(java.lang.String s)
            throws java.lang.ClassNotFoundException
```
    Returns a DataType from its string representation.
    
    Throws:
    
    java.lang.ClassNotFoundException
  - of
```
static DataType of(java.lang.Class clazz)
```
    Returns the DataType of a class.
  - of
```
static DataType of(java.sql.JDBCType type,
                   boolean nullable,
                   java.lang.String dbms)
```
    Returns the DataType of a JDBC type.
    
    Parameters:
    
    type - a JDBCType
    
    nullable - true if the column value may be null
    
    dbms - The database product name.
  - prompt
```
static DataType prompt(DataType a,
                       DataType b)
```
    Type promotion when apply to expressions. First, all byte, short, and char values are promoted to int. Then, if one operand is a long, the whole expression is promoted to long. If one operand is a float, the entire expression is promoted to float. If any of the operands is double, the result is double.
  - coerce
```
static DataType coerce(DataType a,
                       DataType b)
```
    Returns the common type. This method is intended to be used for inferring the schema from text files. This is NOT a general implementation of type coercion.
  - isInt
```
static boolean isInt(DataType t)
```
    Returns true if the given type is of int, short, byte, char, either primitive or boxed.
  - isLong
```
static boolean isLong(DataType t)
```
    Returns true if the given type is of long, either primitive or boxed.
  - isFloat
```
static boolean isFloat(DataType t)
```
    Returns true if the given type is of float, either primitive or boxed.
  - isDouble
```
static boolean isDouble(DataType t)
```
    Returns true if the given type is of double, either primitive or boxed.

Interface DataType

Nested Class Summary

Field Summary

Method Summary

Field Detail

BooleanPattern

IntPattern

LongPattern

DoublePattern

DatePattern

TimePattern

DateTimePattern

Method Detail

name

id

valueOf

toString

isPrimitive

isFloating

isIntegral

isNumeric

isBoolean

isChar

isByte

isShort

isInt

isLong

isFloat

isDouble

isString

isObject

boxed

unboxed

infer

of

of

of

prompt

coerce

isInt

isLong

isFloat

isDouble