Record Class TableMetadata

java.lang.Object

java.lang.Record

dimstyl.orm.metadata.TableMetadata

Record Components:

tableName - The name of the table.

uniqueConstraints - An array of UniqueConstraint applied to the table.

columnMetadataList - A list containing ColumnMetadata for all columns in the table.

All Implemented Interfaces:

Metadata

public record TableMetadata(String tableName, UniqueConstraint[] uniqueConstraints, List<ColumnMetadata> columnMetadataList)
extends Record
implements Metadata

Represents metadata for a database table, including its name, unique constraints, and associated column metadata.

This record provides structural details about a database table, such as the table name, unique constraints, and the list of column metadata associated with it.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ColumnMetadata>	columnMetadataList	The field for the columnMetadataList record component.
private final String	tableName	The field for the tableName record component.
private final UniqueConstraint[]	uniqueConstraints	The field for the uniqueConstraints record component.

Constructor Summary

Constructors

Constructor	Description
TableMetadata(String tableName, UniqueConstraint[] uniqueConstraints, List<ColumnMetadata> columnMetadataList)	Creates an instance of a TableMetadata record class.

Method Summary

Modifier and Type	Method	Description
void	addColumnMetadata(ColumnMetadata columnMetadata)	Adds a column's metadata to the table's column metadata list.
List<ColumnMetadata>	columnMetadataList()	Returns the value of the columnMetadataList 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	tableName()	Returns the value of the tableName record component.
final String	toString()	Returns a string representation of this record class.
UniqueConstraint[]	uniqueConstraints()	Returns the value of the uniqueConstraints record component.

Methods inherited from class java.lang.Object

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

Field Details

tableName

private final String tableName

The field for the tableName record component.

uniqueConstraints

private final UniqueConstraint[] uniqueConstraints

The field for the uniqueConstraints record component.

columnMetadataList

private final List<ColumnMetadata> columnMetadataList

The field for the columnMetadataList record component.

Constructor Details

TableMetadata

public TableMetadata(String tableName,
 UniqueConstraint[] uniqueConstraints,
 List<ColumnMetadata> columnMetadataList)

Creates an instance of a TableMetadata record class.

Parameters:

tableName - the value for the tableName record component

uniqueConstraints - the value for the uniqueConstraints record component

columnMetadataList - the value for the columnMetadataList record component

Method Details

addColumnMetadata

public void addColumnMetadata(ColumnMetadata columnMetadata)

Adds a column's metadata to the table's column metadata list.

Parameters:

columnMetadata - The ColumnMetadata to be added.

Throws:

NullPointerException - if columnMetadata is null.

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

tableName

public String tableName()

Returns the value of the tableName record component.

Returns:

the value of the tableName record component

uniqueConstraints

public UniqueConstraint[] uniqueConstraints()

Returns the value of the uniqueConstraints record component.

Returns:

the value of the uniqueConstraints record component

columnMetadataList

public List<ColumnMetadata> columnMetadataList()

Returns the value of the columnMetadataList record component.

Returns:

the value of the columnMetadataList record component