Record Class TableSchema.ColumnDefinition

java.lang.Object

java.lang.Record

group.worldstandard.pudel.api.database.TableSchema.ColumnDefinition

Record Components:

name - the column name

type - the column's data type

size - the optional maximum size for variable-length types (e.g. VARCHAR/NUMERIC)

nullable - whether the column allows NULL values

defaultValue - the default value as a string, compatible with the column type (may be null)

Enclosing class:

TableSchema

public static record TableSchema.ColumnDefinition(String name, ColumnType type, Integer size, boolean nullable, String defaultValue)
extends Record

Represents the definition of a database column within a table schema. Contains metadata about the column including its name, data type, size, nullability constraint, and default value.

This record is used internally by the schema builder to construct database table definitions. Column definitions are immutable once created.

The column type determines how the column is represented in SQL, with optional size parameters for variable-length types like VARCHAR or NUMERIC. Nullability controls whether the column can contain NULL values. Default values are specified as strings and should be compatible with the column's data type.

Constructor Summary

Constructors

Constructor	Description
ColumnDefinition(String name, ColumnType type, Integer size, boolean nullable, String defaultValue)	Creates an instance of a ColumnDefinition record class.

Method Summary

Modifier and Type	Method	Description
String	defaultValue()	Returns the value of the defaultValue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
boolean	nullable()	Returns the value of the nullable record component.
Integer	size()	Returns the value of the size record component.
final String	toString()	Returns a string representation of this record class.
ColumnType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

ColumnDefinition

public ColumnDefinition(String name,
 ColumnType type,
 Integer size,
 boolean nullable,
 String defaultValue)

Creates an instance of a ColumnDefinition record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

size - the value for the size record component

nullable - the value for the nullable record component

defaultValue - the value for the defaultValue record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public ColumnType type()

Returns the value of the type record component.

Returns:

the value of the type record component

size

public Integer size()

Returns the value of the size record component.

Returns:

the value of the size record component

nullable

public boolean nullable()

Returns the value of the nullable record component.

Returns:

the value of the nullable record component

defaultValue

public String defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component