Package com.github.tadukoo.database.mysql.syntax

Class ForeignKeyConstraint.ForeignKeyConstraintBuilder

java.lang.Object

com.github.tadukoo.database.mysql.syntax.ForeignKeyConstraint.ForeignKeyConstraintBuilder

All Implemented Interfaces:

ForeignKeyConstraint.ColumnNames, ForeignKeyConstraint.OptionsOrBuild, ForeignKeyConstraint.ReferenceColumnNames, ForeignKeyConstraint.ReferenceTable

Enclosing class:

ForeignKeyConstraint

public static class ForeignKeyConstraint.ForeignKeyConstraintBuilder
extends Object
implements ForeignKeyConstraint.ColumnNames, ForeignKeyConstraint.ReferenceTable, ForeignKeyConstraint.ReferenceColumnNames, ForeignKeyConstraint.OptionsOrBuild

A builder to use to make a ForeignKeyConstraint. It takes the following parameters:

Foreign Key Constraint Parameters

Parameter	Description	Default or Required
columnNames	The names of the columns for the foreign key	Required
referenceTable	The name of the reference table for the foreign key	Required
referenceColumnNames	The names of the columns from the reference table	Required
onDeleteOption	The reference option for on delete	Defaults to null
onUpdateOption	The reference option for on update	Defaults to null

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	columnNames	The names of the columns for the foreign key
private SQLReferenceOption	onDeleteOption	The reference option for on delete
private SQLReferenceOption	onUpdateOption	The reference option for on update
private List<String>	referenceColumnNames	The names of the columns from the reference table
private String	referenceTable	The name of the reference table for the foreign key

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ForeignKeyConstraintBuilder()	Not allowed to instantiate outside of ForeignKeyConstraint

Method Summary

Modifier and Type	Method	Description
ForeignKeyConstraint	build()	Builds a new ForeignKeyConstraint using the set parameters
private void	checkForErrors()	Checks for any errors in the set parameters and will throw an error if any are found
ForeignKeyConstraint.ReferenceTable	columnDefs(ColumnDefinition... columnDefs)
ForeignKeyConstraint.ReferenceTable	columnDefs(List<ColumnDefinition> columnDefs)
ForeignKeyConstraint.ReferenceTable	columnNames(String... columnNames)
ForeignKeyConstraint.ReferenceTable	columnNames(List<String> columnNames)
ForeignKeyConstraint.ReferenceTable	columnRefs(ColumnRef... columnRefs)
ForeignKeyConstraint.ReferenceTable	columnRefs(List<ColumnRef> columnRefs)
ForeignKeyConstraint.OptionsOrBuild	onDelete(SQLReferenceOption onDeleteOption)
ForeignKeyConstraint.OptionsOrBuild	onUpdate(SQLReferenceOption onUpdateOption)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnDefs(ColumnDefinition... referenceColumnDefs)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnDefs(List<ColumnDefinition> referenceColumnDefs)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnNames(String... referenceColumnNames)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnNames(List<String> referenceColumnNames)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnRefs(ColumnRef... referenceColumnRefs)
ForeignKeyConstraint.OptionsOrBuild	referenceColumnRefs(List<ColumnRef> referenceColumnRefs)
ForeignKeyConstraint.ReferenceColumnNames	references(TableRef referenceTable)
ForeignKeyConstraint.ReferenceColumnNames	references(String referenceTable)

Methods inherited from class java.lang.Object

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

Field Details

columnNames

private List<String> columnNames

The names of the columns for the foreign key

referenceTable

private String referenceTable

The name of the reference table for the foreign key

referenceColumnNames

private List<String> referenceColumnNames

The names of the columns from the reference table

onDeleteOption

private SQLReferenceOption onDeleteOption

The reference option for on delete

onUpdateOption

private SQLReferenceOption onUpdateOption

The reference option for on update

Constructor Details

ForeignKeyConstraintBuilder

private ForeignKeyConstraintBuilder()

Not allowed to instantiate outside of ForeignKeyConstraint

Method Details

columnNames

public ForeignKeyConstraint.ReferenceTable columnNames(String... columnNames)

Specified by:

columnNames in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnNames - The names of the columns for the foreign key

Returns:

this, to continue building

columnNames

public ForeignKeyConstraint.ReferenceTable columnNames(List<String> columnNames)

Specified by:

columnNames in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnNames - The names of the columns for the foreign key

Returns:

this, to continue building

columnRefs

public ForeignKeyConstraint.ReferenceTable columnRefs(ColumnRef... columnRefs)

Specified by:

columnRefs in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnRefs - The columns for the foreign key as ColumnRefs

Returns:

this, to continue building

columnRefs

public ForeignKeyConstraint.ReferenceTable columnRefs(List<ColumnRef> columnRefs)

Specified by:

columnRefs in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnRefs - The columns for the foreign key as ColumnRefs

Returns:

this, to continue building

columnDefs

public ForeignKeyConstraint.ReferenceTable columnDefs(ColumnDefinition... columnDefs)

Specified by:

columnDefs in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnDefs - The columns for the foreign key as ColumnDefinitions

Returns:

this, to continue building

columnDefs

public ForeignKeyConstraint.ReferenceTable columnDefs(List<ColumnDefinition> columnDefs)

Specified by:

columnDefs in interface ForeignKeyConstraint.ColumnNames

Parameters:

columnDefs - The columns for the foreign key as ColumnDefinitions

Returns:

this, to continue building

references

public ForeignKeyConstraint.ReferenceColumnNames references(String referenceTable)

Specified by:

references in interface ForeignKeyConstraint.ReferenceTable

Parameters:

referenceTable - The name of the reference table for the foreign key

Returns:

this, to continue building

references

public ForeignKeyConstraint.ReferenceColumnNames references(TableRef referenceTable)

Specified by:

references in interface ForeignKeyConstraint.ReferenceTable

Parameters:

referenceTable - The reference table for the foreign key as a TableRef

Returns:

this, to continue building

referenceColumnNames

public ForeignKeyConstraint.OptionsOrBuild referenceColumnNames(String... referenceColumnNames)

Specified by:

referenceColumnNames in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnNames - The names of the columns from the reference table

Returns:

this, to continue building

referenceColumnNames

public ForeignKeyConstraint.OptionsOrBuild referenceColumnNames(List<String> referenceColumnNames)

Specified by:

referenceColumnNames in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnNames - The names of the columns from the reference table

Returns:

this, to continue building

referenceColumnRefs

public ForeignKeyConstraint.OptionsOrBuild referenceColumnRefs(ColumnRef... referenceColumnRefs)

Specified by:

referenceColumnRefs in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnRefs - The columns from the reference table as ColumnRefs

Returns:

this, to continue building

referenceColumnRefs

public ForeignKeyConstraint.OptionsOrBuild referenceColumnRefs(List<ColumnRef> referenceColumnRefs)

Specified by:

referenceColumnRefs in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnRefs - The columns from the reference table as ColumnRefs

Returns:

this, to continue building

referenceColumnDefs

public ForeignKeyConstraint.OptionsOrBuild referenceColumnDefs(ColumnDefinition... referenceColumnDefs)

Specified by:

referenceColumnDefs in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnDefs - The columns from the reference table as ColumnDefinitions

Returns:

this, to continue building

referenceColumnDefs

public ForeignKeyConstraint.OptionsOrBuild referenceColumnDefs(List<ColumnDefinition> referenceColumnDefs)

Specified by:

referenceColumnDefs in interface ForeignKeyConstraint.ReferenceColumnNames

Parameters:

referenceColumnDefs - The columns from the reference table as ColumnDefinitions

Returns:

this, to continue building

onDelete

public ForeignKeyConstraint.OptionsOrBuild onDelete(SQLReferenceOption onDeleteOption)

Specified by:

onDelete in interface ForeignKeyConstraint.OptionsOrBuild

Parameters:

onDeleteOption - The reference option for on delete

Returns:

this, to continue building

onUpdate

public ForeignKeyConstraint.OptionsOrBuild onUpdate(SQLReferenceOption onUpdateOption)

Specified by:

onUpdate in interface ForeignKeyConstraint.OptionsOrBuild

Parameters:

onUpdateOption - The reference option for on update

Returns:

this, to continue building

checkForErrors

private void checkForErrors()

Checks for any errors in the set parameters and will throw an error if any are found

build

public ForeignKeyConstraint build()

Builds a new ForeignKeyConstraint using the set parameters

Specified by:

build in interface ForeignKeyConstraint.OptionsOrBuild

Returns:

The newly built ForeignKeyConstraint