Package io.github.mfvanek.pg.model.index

Class ForeignKey

java.lang.Object

io.github.mfvanek.pg.model.index.ForeignKey

All Implemented Interfaces:

TableNameAware

@Immutable
public class ForeignKey
extends Object
implements TableNameAware

A representation of foreign key in a database.

See Also:

• TableNameAware

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object other)
List<Column>	getColumnsInConstraint()	Gets columns of foreign key constraint.
String	getConstraintName()	Gets the name of foreign key constraint.
String	getTableName()	Gets table name.
final int	hashCode()
static ForeignKey	of(String tableName, String constraintName, List<Column> columnsInConstraint)
static ForeignKey	ofColumn(String tableName, String constraintName, Column column)
static ForeignKey	ofNotNullColumn(String tableName, String constraintName, String columnName)
static ForeignKey	ofNullableColumn(String tableName, String constraintName, String columnName)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getTableName

@Nonnull
public String getTableName()

Gets table name.

Specified by:

getTableName in interface TableNameAware

Returns:

table name

getConstraintName

@Nonnull
public String getConstraintName()

Gets the name of foreign key constraint.

Returns:

the name of foreign key

getColumnsInConstraint

@Nonnull
public List<Column> getColumnsInConstraint()

Gets columns of foreign key constraint.

Returns:

columns of foreign key constraint

See Also:

• Column

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

@Nonnull
public static ForeignKey of(@Nonnull
 String tableName,
 @Nonnull
 String constraintName,
 @Nonnull
 List<Column> columnsInConstraint)

ofColumn

@Nonnull
public static ForeignKey ofColumn(@Nonnull
 String tableName,
 @Nonnull
 String constraintName,
 @Nonnull
 Column column)

ofNotNullColumn

@Nonnull
public static ForeignKey ofNotNullColumn(@Nonnull
 String tableName,
 @Nonnull
 String constraintName,
 @Nonnull
 String columnName)

ofNullableColumn

@Nonnull
public static ForeignKey ofNullableColumn(@Nonnull
 String tableName,
 @Nonnull
 String constraintName,
 @Nonnull
 String columnName)