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

Class SQLAlterStatement.SQLAlterStatementBuilder

java.lang.Object

com.github.tadukoo.database.mysql.syntax.statement.SQLAlterStatement.SQLAlterStatementBuilder

All Implemented Interfaces:

SQLAlterStatement.Build, SQLAlterStatement.ColumnDef, SQLAlterStatement.ColumnDefOrForeignKey, SQLAlterStatement.ColumnName, SQLAlterStatement.Operation, SQLAlterStatement.TableName, SQLAlterStatement.Type

Enclosing class:

SQLAlterStatement

public static class SQLAlterStatement.SQLAlterStatementBuilder
extends Object
implements SQLAlterStatement.Type, SQLAlterStatement.TableName, SQLAlterStatement.Operation, SQLAlterStatement.ColumnName, SQLAlterStatement.ColumnDefOrForeignKey, SQLAlterStatement.ColumnDef, SQLAlterStatement.Build

A builder to use to build a SQLAlterStatement. It takes the following parameters:

SQL Alter Statement Parameters

Parameter	Description	Default or Required
type	The type to be altered	Required
tableName	The name of the table to alter	Required
operation	The operation to perform	Required
columnName	The name of the column to alter	Either this or columnDef or foreignKey required, depending on operation
columnDef	The column definition to be used	Either this or columnName or foreign key required, depending on operation
foreignKey	The foreign key to be added to the table	Either this or columnName or columnDef required, depending on operation

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private ColumnDefinition	columnDef	The column definition to be used
private String	columnName	The name of the column to alter
private ForeignKeyConstraint	foreignKey	The foreign key to be added to the table
private SQLColumnOperation	operation	The operation to perform
private String	tableName	The name of the table to alter
private SQLType	type	The type to be altered

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SQLAlterStatementBuilder()	Not allowed to instantiate outside SQLAlterStatement

Method Summary

Modifier and Type	Method	Description
SQLAlterStatement.ColumnDefOrForeignKey	add()	Sets the operation to add a column
SQLAlterStatement	build()	Builds a new SQLAlterStatement using the set parameters
private void	checkForErrors()	Checks for any errors in the set parameters and throws an exception if any are found
SQLAlterStatement.Build	columnDef(ColumnDefinition columnDef)
SQLAlterStatement.Build	columnName(String columnName)
SQLAlterStatement.ColumnName	drop()	Sets the operation to drop a column
SQLAlterStatement.Build	foreignKey(ForeignKeyConstraint foreignKey)
SQLAlterStatement.ColumnDef	modify()	Sets the operation to modify a column
SQLAlterStatement.TableName	table()	Set the type to altering a table
SQLAlterStatement.Operation	tableName(String tableName)

Methods inherited from class java.lang.Object

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

Field Details

type

private SQLType type

The type to be altered

tableName

private String tableName

The name of the table to alter

operation

private SQLColumnOperation operation

The operation to perform

columnName

private String columnName

The name of the column to alter

columnDef

private ColumnDefinition columnDef

The column definition to be used

foreignKey

private ForeignKeyConstraint foreignKey

The foreign key to be added to the table

Constructor Details

SQLAlterStatementBuilder

private SQLAlterStatementBuilder()

Not allowed to instantiate outside SQLAlterStatement

Method Details

table

public SQLAlterStatement.TableName table()

Set the type to altering a table

Specified by:

table in interface SQLAlterStatement.Type

Returns:

this, to continue building

tableName

public SQLAlterStatement.Operation tableName(String tableName)

Specified by:

tableName in interface SQLAlterStatement.TableName

Parameters:

tableName - The name of the table to alter

Returns:

this, to continue building

add

public SQLAlterStatement.ColumnDefOrForeignKey add()

Sets the operation to add a column

Specified by:

add in interface SQLAlterStatement.Operation

Returns:

this, to continue building

modify

public SQLAlterStatement.ColumnDef modify()

Sets the operation to modify a column

Specified by:

modify in interface SQLAlterStatement.Operation

Returns:

this, to continue building

drop

public SQLAlterStatement.ColumnName drop()

Sets the operation to drop a column

Specified by:

drop in interface SQLAlterStatement.Operation

Returns:

this, to continue building

columnName

public SQLAlterStatement.Build columnName(String columnName)

Specified by:

columnName in interface SQLAlterStatement.ColumnName

Parameters:

columnName - The name of the column to alter

Returns:

this, to continue building

foreignKey

public SQLAlterStatement.Build foreignKey(ForeignKeyConstraint foreignKey)

Specified by:

foreignKey in interface SQLAlterStatement.ColumnDefOrForeignKey

Parameters:

foreignKey - The foreign key to add to the table

Returns:

this, to continue building

columnDef

public SQLAlterStatement.Build columnDef(ColumnDefinition columnDef)

Specified by:

columnDef in interface SQLAlterStatement.ColumnDef

Parameters:

columnDef - The column definition to be used

Returns:

this, to continue building

checkForErrors

private void checkForErrors()

Checks for any errors in the set parameters and throws an exception if any are found

build

public SQLAlterStatement build()

Builds a new SQLAlterStatement using the set parameters

Specified by:

build in interface SQLAlterStatement.Build

Returns:

The newly built SQLAlterStatement