com.datastrato.gravitino.dto.rel

Class ColumnDTO

java.lang.Object

com.datastrato.gravitino.dto.rel.ColumnDTO

All Implemented Interfaces:

Column

public class ColumnDTO
extends java.lang.Object
implements Column

Represents a Column DTO (Data Transfer Object).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnDTO.Builder<S extends ColumnDTO.Builder> Builder class for constructing ColumnDTO instances.

Nested classes/interfaces inherited from interface com.datastrato.gravitino.rel.Column

Column.ColumnImpl

Field Summary

Fields inherited from interface com.datastrato.gravitino.rel.Column

DEFAULT_VALUE_NOT_SET, DEFAULT_VALUE_OF_CURRENT_TIMESTAMP

Method Summary

Modifier and Type	Method and Description
boolean	autoIncrement()
static ColumnDTO.Builder	builder() Creates a new Builder to build a Column DTO.
java.lang.String	comment()
Type	dataType()
Expression	defaultValue()
java.lang.String	name()
boolean	nullable()
void	validate() Validates the Column DTO.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.datastrato.gravitino.rel.Column

of, of, of, of

Method Detail

name

public java.lang.String name()

Specified by:

name in interface Column

Returns:

The name of this column.

dataType

public Type dataType()

Specified by:

dataType in interface Column

Returns:

The data type of this column.

comment

public java.lang.String comment()

Specified by:

comment in interface Column

Returns:

The comment of this column, null if not specified.

nullable

public boolean nullable()

Specified by:

nullable in interface Column

Returns:

True if this column may produce null values. Default is true.

autoIncrement

public boolean autoIncrement()

Specified by:

autoIncrement in interface Column

Returns:

True if this column is an auto-increment column. Default is false.

defaultValue

public Expression defaultValue()

Specified by:

defaultValue in interface Column

Returns:

The default value of this column, Column.DEFAULT_VALUE_NOT_SET if not specified

builder

public static ColumnDTO.Builder builder()

Creates a new Builder to build a Column DTO.

Returns:

A new Builder instance.

validate

public void validate()
              throws java.lang.IllegalArgumentException

Validates the Column DTO.

Throws:

java.lang.IllegalArgumentException - If some of the required fields are not set or if the column is non-nullable with a null default value, this method will throw an IllegalArgumentException.