Package com.github.tadukoo.database.mysql

Class Database.DatabaseBuilder

java.lang.Object

com.github.tadukoo.database.mysql.Database.DatabaseBuilder

All Implemented Interfaces:

Database.Build, Database.DatabaseNameOrUsername, Database.Host, Database.Logger, Database.MaxAttemptsOrBuild, Database.Password, Database.PortOrDatabaseNameOrUsername, Database.Username

Enclosing class:

Database

public static class Database.DatabaseBuilder
extends Object
implements Database.Logger, Database.Host, Database.PortOrDatabaseNameOrUsername, Database.DatabaseNameOrUsername, Database.Username, Database.Password, Database.MaxAttemptsOrBuild, Database.Build

A Builder to use to build a Database. It takes the following parameters:

Database Parameters

Parameter	Description	Default or Required
logger	The logger to use for logging	Required
host	The MySQL host url	Required
port	The MySQL host port	Defaults to 3306
databaseName	The MySQL host database name	Defaults to null (used e.g. when creating the database on the server)
username	The MySQL username for connecting to the Database	Required
password	The MySQL password for connecting to the Database	Required, may be the empty string for a blank password
maxAttempts	The maximum number of attempts to try a SQL transaction before giving up	Defaults to 10

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private String	databaseName	The MySQL host database name
private String	host	The MySQL host url
private com.github.tadukoo.util.logger.EasyLogger	logger	The logger to use for logging
private int	maxAttempts	The maximum number of attempts to try a SQL transaction before giving up
private String	password	The MySQL password for connecting to the Database
private int	port	The MySQL host port
private String	username	The MySQL username for connecting to the Database

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DatabaseBuilder()	Not allowed to instantiate outside of Database

Method Summary

Modifier and Type	Method	Description
Database	build()	Builds a new Database with the set parameters
private void	checkForErrors()	Checks for any errors with the set parameters and will throw an IllegalArgumentException if any are found
Database.Username	databaseName(String databaseName)
Database.PortOrDatabaseNameOrUsername	host(String host)
Database.Host	logger(com.github.tadukoo.util.logger.EasyLogger logger)
Database.Build	maxAttempts(int maxAttempts)
Database.MaxAttemptsOrBuild	password(String password)
Database.DatabaseNameOrUsername	port(int port)
Database.Password	username(String username)

Methods inherited from class java.lang.Object

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

Field Details

logger

private com.github.tadukoo.util.logger.EasyLogger logger

The logger to use for logging

host

private String host

The MySQL host url

port

private int port

The MySQL host port

databaseName

private String databaseName

The MySQL host database name

username

private String username

The MySQL username for connecting to the Database

password

private String password

The MySQL password for connecting to the Database

maxAttempts

private int maxAttempts

The maximum number of attempts to try a SQL transaction before giving up

Constructor Details

DatabaseBuilder

private DatabaseBuilder()

Not allowed to instantiate outside of Database

Method Details

logger

public Database.Host logger(com.github.tadukoo.util.logger.EasyLogger logger)

Specified by:

logger in interface Database.Logger

Parameters:

logger - The logger to use for logging

Returns:

this, to continue building

host

public Database.PortOrDatabaseNameOrUsername host(String host)

Specified by:

host in interface Database.Host

Parameters:

host - The MySQL host url

Returns:

this, to continue building

port

public Database.DatabaseNameOrUsername port(int port)

Specified by:

port in interface Database.PortOrDatabaseNameOrUsername

Parameters:

port - The MySQL host port

Returns:

this, to continue building

databaseName

public Database.Username databaseName(String databaseName)

Specified by:

databaseName in interface Database.DatabaseNameOrUsername

Parameters:

databaseName - The MySQL host database name

Returns:

this, to continue building

username

public Database.Password username(String username)

Specified by:

username in interface Database.Username

Parameters:

username - The MySQL username for connecting to the database

Returns:

this, to continue building

password

public Database.MaxAttemptsOrBuild password(String password)

Specified by:

password in interface Database.Password

Parameters:

password - The MySQL password for connecting to the database

Returns:

this, to continue building

maxAttempts

public Database.Build maxAttempts(int maxAttempts)

Specified by:

maxAttempts in interface Database.MaxAttemptsOrBuild

Parameters:

maxAttempts - The maximum amount of attempts to try a SQL transaction before giving up

Returns:

this, to continue building

checkForErrors

private void checkForErrors()

Checks for any errors with the set parameters and will throw an IllegalArgumentException if any are found

build

public Database build()

Builds a new Database with the set parameters

Specified by:

build in interface Database.Build

Returns:

The newly built Database