TableRef.TableRefBuilder

java.lang.Object

com.github.tadukoo.database.mysql.syntax.reference.TableRef.TableRefBuilder

All Implemented Interfaces:: TableRef.AliasAndBuild, TableRef.TableName

Enclosing class:: TableRef

public static class TableRef.TableRefBuilder extends Object implements TableRef.TableName, TableRef.AliasAndBuild

A builder to build a new TableRef. It uses the following parameters:

TableRef Parameters
Parameter	Description	Required or Default
tableName	The name of the table	Required
alias	The alias to use for the table	Defaults to null (no alias)

Version:: Alpha v.0.3
Author:: Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type

Field

Description

private String

alias

The alias to use for the table

private String

tableName

The name of the table
Constructor Summary

Constructors

Modifier

Constructor

Description

private

TableRefBuilder()

Not allowed to instantiate outside TableRef
Method Summary

Modifier and Type

Method

Description

TableRef.AliasAndBuild

alias(String alias)

TableRef

build()

Builds a new TableRef with the set parameters

private void

checkForErrors()

Checks for any errors with the set parameters

TableRef.AliasAndBuild

tableName(String tableName)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- tableName
  
  private String tableName
  
  The name of the table
- alias
  
  private String alias
  
  The alias to use for the table
Constructor Details
- TableRefBuilder
  
  private TableRefBuilder()
  
  Not allowed to instantiate outside TableRef
Method Details
- tableName
  
  public TableRef.AliasAndBuild tableName(String tableName)
  
  Specified by:
  
  tableName in interface TableRef.TableName
  
  Parameters:
  
  tableName - The name of the table
  
  Returns:
  
  this, to continue building
- alias
  
  public TableRef.AliasAndBuild alias(String alias)
  
  Specified by:
  
  alias in interface TableRef.AliasAndBuild
  
  Parameters:
  
  alias - The alias to use for the table
  
  Returns:
  
  this, to continue building
- checkForErrors
  
  private void checkForErrors()
  
  Checks for any errors with the set parameters
- build
  
  public TableRef build()
  
  Builds a new TableRef with the set parameters
  
  Specified by:
  
  build in interface TableRef.AliasAndBuild
  
  Returns:
  
  The newly built TableRef