MySQLConnectionFactory (ConnectionFactory 1.0.0 API)

java.lang.Object
- com.MySQL.Connection.MySQLConnectionFactory

```
public class MySQLConnectionFactory
extends Object
```
A Class to connect at MySQL
For this, Is used the MySQL Connector java 8.0.22

Since:

Jan 2021

Version:

1.0.0

Author:

Samuel Ricardo Cabral de Barros

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DRIVER` Default Driver Location This driver refers to the latest JDBC (mysql-connector-java 8.0.22) if you use an older JDBC such as mysql-connector-java 5.1.48, then use `OLD_DEFAULT_DRIVER`
`static String`	`DEFAULT_HOST` Default Database Host
`static String`	`DEFAULT_PASSWORD` Default Database Password Registred
`static String`	`DEFAULT_PORT` Default Database Port
`static String`	`DEFAULT_USER` Default Database User Registred
`static String`	`OLD_DEFAULT_DRIVER` Default Driver Location This driver refers to older JDBCs as mysql-connector-java 5.1.48 if you use a newer JDBC, like mysql-connector-java 8.0.22, use `DEFAULT_DRIVER`

Constructor Summary

Constructors
Constructor and Description

MySQLConnectionFactory()

Constructors
Constructor and Description
`MySQLConnectionFactory()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cleanFactory()` Clean the class fields - DRIVER - HOST - PORT - DATABASE - USER - PASSWORD - URL
`static boolean`	`closeConnection(Connection connection)` Method responsible for closing the connection
`static boolean`	`closeConnection(Connection connection, PreparedStatement statement)` Method responsible for closing the connection It Calls The `closeConnection(java.sql.Connection)`
`static boolean`	`closeConnection(Connection connection, PreparedStatement statement, ResultSet result)` Method responsible for closing the connection It Calls The `closeConnection(java.sql.Connection, java.sql.PreparedStatement)`
`static Connection`	`getConnection(String database)` Method responsible for making a connection first It Calls The `loadClass(java.lang.String)` function that loads the class with the data passed by parameter after he `try` to import the driver, if he `catch` an `ClassNotFoundException` he will `throw` a `RuntimeException` if he imported the driver with success, he will `try` to connect to the database, if he `catch` an `SQLException` he will `throw` `RuntimeException`
`static Connection`	`getConnection(String host, String port, String database, String user, String password)` Method responsible for making a connection first It Calls The `loadClass(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)` function that loads the class with the data passed by parameter after he `try` to import the driver, if he `catch` an `ClassNotFoundException` he will `throw` a `RuntimeException` if he imported the driver with success, he will `try` to connect to the database, if he `catch` an `SQLException` he will `throw` `RuntimeException`
`static Connection`	`getConnection(String driver, String host, String port, String database, String user, String password)` Method responsible for making a connection first It Calls The `loadClass(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)` function that loads the class with the data passed by parameter after he `try` to import the driver, if he `catch` an `ClassNotFoundException` he will `throw` a `RuntimeException` if he imported the driver with success, he will `try` to connect to the database, if he `catch` an `SQLException` he will `throw` `RuntimeException`
`static String`	`getDATABASE()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException`
`static String`	`getDRIVER()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` The Driver receives by default: `DEFAULT_DRIVER`, however, it can be modified by calling the `getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)` method by passing briver as a parameter
`static String`	`getHOST()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` It receives by default: `DEFAULT_HOST`, however, it can be modified by calling the `getConnection()` method by passing host as a parameter if you don't know or use a standard Host, try to use the `DEFAULT_HOST`
`static String`	`getPASSWORD()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` It receives by default: `DEFAULT_PASSWORD`, however, it can be modified by calling the `getConnection()` method by passing password as a parameter if you don't know or use a standard Password, try to use the `DEFAULT_USER`
`static String`	`getPORT()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` It receives by default: `DEFAULT_PORT`, however, it can be modified by calling the `getConnection()` method by passing port as a parameter if you don't know or use a standard Port, try to use the `DEFAULT_PORT`
`static String`	`getURL()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` if you don't know or use a standard Url, try to use the `getURL(java.lang.String, java.lang.String, java.lang.String)`
`static String`	`getURL(String host, String port, String database)` Generate URL to connect whit Database
`static String`	`getUSER()` AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN `throw` `NullPointerException` It receives by default: `DEFAULT_USER`, however, it can be modified by calling the `getConnection()` method by passing User as a parameter if you don't know or use a standard User, try to use the `DEFAULT_USER`
`static void`	`resetFactory()` Reset the class fields - DRIVER - HOST - PORT - DATABASE - USER - PASSWORD - URL This function call `loadClass(java.lang.String)`

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

- Field Detail
  - DEFAULT_USER
```
public static final String DEFAULT_USER
```
    Default Database User Registred
    
    See Also:
    
    USER, Constant Field Values
  - DEFAULT_PASSWORD
```
public static final String DEFAULT_PASSWORD
```
    Default Database Password Registred
    
    See Also:
    
    PASSWORD, Constant Field Values
  - DEFAULT_DRIVER
```
public static final String DEFAULT_DRIVER
```
    Default Driver Location
    This driver refers to the latest JDBC (mysql-connector-java 8.0.22)
    if you use an older JDBC such as mysql-connector-java 5.1.48, then use OLD_DEFAULT_DRIVER
    
    See Also:
    
    DRIVER, OLD_DEFAULT_DRIVER, Constant Field Values
  - OLD_DEFAULT_DRIVER
```
public static final String OLD_DEFAULT_DRIVER
```
    Default Driver Location
    This driver refers to older JDBCs as mysql-connector-java 5.1.48
    if you use a newer JDBC, like mysql-connector-java 8.0.22, use DEFAULT_DRIVER
    
    See Also:
    
    DRIVER, DEFAULT_DRIVER, Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    Default Database Host
    
    See Also:
    
    HOST, Constant Field Values
  - DEFAULT_PORT
```
public static final String DEFAULT_PORT
```
    Default Database Port
    
    See Also:
    
    PORT, Constant Field Values
- Constructor Detail
  - MySQLConnectionFactory
```
public MySQLConnectionFactory()
```
- Method Detail
  - getConnection
```
public static Connection getConnection(String database)
```
    Method responsible for making a connection
    first It Calls The loadClass(java.lang.String) function that loads the class with the data passed by parameter
    after he try to import the driver, if he catch an ClassNotFoundException he will throw a RuntimeException
    if he imported the driver with success, he will try to connect to the database, if he catch an SQLException he will throw RuntimeException
    
    Parameters:
    
    database - Name of the Database to be Connected
    
    Returns:
    
    Connection - if everything is successful
    null - if catch a Exception
    
    Throws:
    
    RuntimeException - if the method catch SQLException or ClassNotFoundException
  - getConnection
```
public static Connection getConnection(String host,
                                       String port,
                                       String database,
                                       String user,
                                       String password)
```
    Method responsible for making a connection
    first It Calls The loadClass(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) function that loads the class with the data passed by parameter
    after he try to import the driver, if he catch an ClassNotFoundException he will throw a RuntimeException
    if he imported the driver with success, he will try to connect to the database, if he catch an SQLException he will throw RuntimeException
    
    Parameters:
    
    host - Database Host
    
    port - Database Port
    
    database - Name of the Database to be Connected
    
    user - Database User Registred
    
    password - Database Password Registred
    
    Returns:
    
    Connection - if everything is successful
    null - if catch a Exception
    
    Throws:
    
    RuntimeException - if the method catch SQLException or ClassNotFoundException
  - getConnection
```
public static Connection getConnection(String driver,
                                       String host,
                                       String port,
                                       String database,
                                       String user,
                                       String password)
```
    Method responsible for making a connection
    first It Calls The loadClass(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) function that loads the class with the data passed by parameter
    after he try to import the driver, if he catch an ClassNotFoundException he will throw a RuntimeException
    if he imported the driver with success, he will try to connect to the database, if he catch an SQLException he will throw RuntimeException
    
    Parameters:
    
    driver - Driver location
    
    host - Database Host
    
    port - Database Port
    
    database - Name of the Database to be Connected
    
    user - Database User Registred
    
    password - Database Password Registred
    
    Returns:
    
    Connection - if everything is successful
    null - if catch a Exception
    
    Throws:
    
    RuntimeException - if the method catch SQLException or ClassNotFoundException
  - closeConnection
```
public static boolean closeConnection(Connection connection)
```
    Method responsible for closing the connection
    
    Parameters:
    
    connection - Connection to be closed
    
    Returns:
    
    false - if the Connection has not been closed, this is because the Connection is null or is already closed
    true - if everything is successful
    
    Throws:
    
    RuntimeException - if the method catch SQLException
  - closeConnection
```
public static boolean closeConnection(Connection connection,
                                      PreparedStatement statement)
```
    Method responsible for closing the connection
    It Calls The closeConnection(java.sql.Connection)
    
    Parameters:
    
    connection - Connection to be closed
    
    statement - PreparedStatement to be closed
    
    Returns:
    
    false - if the PreparedStatement has not been closed, this is because the PreparedStatement is null or is already closed
    true - if everything is successful
    
    Throws:
    
    RuntimeException - if the method catch SQLException
  - closeConnection
```
public static boolean closeConnection(Connection connection,
                                      PreparedStatement statement,
                                      ResultSet result)
```
    Method responsible for closing the connection
    It Calls The closeConnection(java.sql.Connection, java.sql.PreparedStatement)
    
    Parameters:
    
    connection - Connection to be closed
    
    statement - PreparedStatement to be closed
    
    result - ResultSet to be closed
    
    Returns:
    
    false - if the ResultSet has not been closed, this is because the ResultSet is null or is already closed
    true - if everything is successful
    
    Throws:
    
    RuntimeException - if the method catch SQLException
  - getURL
```
public static String getURL(String host,
                            String port,
                            String database)
```
    Generate URL to connect whit Database
    
    Parameters:
    
    host - Database Host
    
    port - Database Port
    
    database - Name of the Database to be Connected
    
    Returns:
    
    URL with data to connect with database
  - cleanFactory
```
public static void cleanFactory()
```
    Clean the class fields
    - DRIVER
    - HOST
    - PORT
    - DATABASE
    - USER
    - PASSWORD
    - URL
  - resetFactory
```
public static void resetFactory()
```
    Reset the class fields
    - DRIVER
    - HOST
    - PORT
    - DATABASE
    - USER
    - PASSWORD
    - URL
    
    This function call loadClass(java.lang.String)
  - getDRIVER
```
public static String getDRIVER()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    The Driver receives by default: DEFAULT_DRIVER, however, it can be
    modified by calling the getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
    method by passing briver as a parameter
    
    Returns:
    
    Driver location
    
    See Also:
    
    DEFAULT_DRIVER, getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getHOST
```
public static String getHOST()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    It receives by default: DEFAULT_HOST, however, it can be modified by calling the getConnection() method by passing host as a parameter
    if you don't know or use a standard Host, try to use the DEFAULT_HOST
    
    Returns:
    
    Database Host
    
    See Also:
    
    DEFAULT_HOST, getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getPORT
```
public static String getPORT()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    It receives by default: DEFAULT_PORT, however, it can be modified by calling the getConnection() method by passing port as a parameter
    if you don't know or use a standard Port, try to use the DEFAULT_PORT
    
    See Also:
    
    DEFAULT_PORT, getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getDATABASE
```
public static String getDATABASE()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    
    Returns:
    
    Name of the Database Connected
    
    See Also:
    
    getConnection(java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getURL
```
public static String getURL()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    if you don't know or use a standard Url, try to use the getURL(java.lang.String, java.lang.String, java.lang.String)
    
    Returns:
    
    Database User Registred
    
    See Also:
    
    DEFAULT_USER, getURL(), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getUSER
```
public static String getUSER()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    It receives by default: DEFAULT_USER, however, it can be modified by calling the getConnection() method by passing User as a parameter
    if you don't know or use a standard User, try to use the DEFAULT_USER
    
    Returns:
    
    Database User Registred
    null - if the USER is null
    
    Throws:
    
    NullPointerException - if the USER is null
    
    See Also:
    
    DEFAULT_USER, getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getPASSWORD
```
public static String getPASSWORD()
```
    AVOID USING IF A CONNECTION HAS NOT BEEN CREATED OR CAN throw NullPointerException
    It receives by default: DEFAULT_PASSWORD, however, it can be modified by calling the getConnection() method by passing password as a parameter
    if you don't know or use a standard Password, try to use the DEFAULT_USER
    
    Returns:
    
    Database Password Registred - if not null
    null - if the PASSWORD is null
    
    Throws:
    
    NullPointerException - if the PASSWORD is null
    
    See Also:
    
    DEFAULT_PASSWORD, getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), getConnection(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Class MySQLConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USER

DEFAULT_PASSWORD

DEFAULT_DRIVER

OLD_DEFAULT_DRIVER

DEFAULT_HOST

DEFAULT_PORT

Constructor Detail

MySQLConnectionFactory

Method Detail

getConnection

getConnection

getConnection

closeConnection

closeConnection

closeConnection

getURL

cleanFactory

resetFactory

getDRIVER

getHOST

getPORT

getDATABASE

getURL

getUSER

getPASSWORD