org.apache.gravitino.rel.types

Class Types.StructType.Field

java.lang.Object

org.apache.gravitino.rel.types.Types.StructType.Field

Enclosing class:

Types.StructType

public static class Types.StructType.Field
extends java.lang.Object

A field of a struct type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	comment()
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	name()
static Types.StructType.Field	notNullField(java.lang.String name, Type type)
static Types.StructType.Field	notNullField(java.lang.String name, Type type, java.lang.String comment)
boolean	nullable()
static Types.StructType.Field	nullableField(java.lang.String name, Type type)
static Types.StructType.Field	nullableField(java.lang.String name, Type type, java.lang.String comment)
static Types.StructType.Field	of(java.lang.String name, Type type, boolean nullable, java.lang.String comment)
java.lang.String	simpleString()
Type	type()

Methods inherited from class java.lang.Object

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

Method Detail

notNullField

public static Types.StructType.Field notNullField(java.lang.String name,
                                                  Type type)

Parameters:

name - The name of the field.

type - The type of the field.

Returns:

A NOT NULL Types.StructType.Field with the given name, type and empty comment.

notNullField

public static Types.StructType.Field notNullField(java.lang.String name,
                                                  Type type,
                                                  java.lang.String comment)

Parameters:

name - The name of the field.

type - The type of the field.

comment - The comment of the field.

Returns:

A NOT NULL Types.StructType.Field with the given name, type and comment.

nullableField

public static Types.StructType.Field nullableField(java.lang.String name,
                                                   Type type)

Parameters:

name - The name of the field.

type - The type of the field.

Returns:

A nullable Types.StructType.Field with the given name, type and empty comment.

nullableField

public static Types.StructType.Field nullableField(java.lang.String name,
                                                   Type type,
                                                   java.lang.String comment)

Parameters:

name - The name of the field.

type - The type of the field.

comment - The comment of the field.

Returns:

A nullable Types.StructType.Field with the given name, type and comment.

of

public static Types.StructType.Field of(java.lang.String name,
                                        Type type,
                                        boolean nullable,
                                        java.lang.String comment)

Parameters:

name - The name of the field.

type - The type of the field.

nullable - Whether the field is nullable.

comment - The comment of the field.

Returns:

A nullable Types.StructType.Field with the given name, type and comment.

name

public java.lang.String name()

Returns:

The name of the field.

type

public Type type()

Returns:

The type of the field.

nullable

public boolean nullable()

Returns:

Whether the field is nullable.

comment

public java.lang.String comment()

Returns:

The comment of the field. May be null if not set.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

simpleString

public java.lang.String simpleString()

Returns:

The simple string representation of the field.