com.codelanx.codelanxlib.data.types

Class SQLite

java.lang.Object

com.codelanx.codelanxlib.data.types.SQLite

All Implemented Interfaces:

DataType, SQLDataType, AutoCloseable

public class SQLite
extends Object
implements SQLDataType

Instantiable SQLite connector

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	con The Connection object
protected static byte	connections The number of connections in use by this data type

Constructor Summary

Constructors

Constructor and Description
SQLite()

Method Summary

Modifier and Type	Method and Description
boolean	checkColumn(String tableName, String columnName) Checks if a table has the following column
boolean	checkTable(String tableName) Checks if a table exists within the set database
void	close() Closes the SQLite connection.
Connection	getConnection() Returns the Connection object for ease of use in exposing more internal API
boolean	isSendingErrorOutput() Determines whether or not to automatically print errors to the console
Connection	open(File database) Opens a connection to the SQLite database.
Connection	open(File folder, String name) Opens a connection to the SQLite database.
Connection	open(Plugin plugin) Opens a connection to the SQLite database.
Connection	open(Plugin plugin, String name) Opens a connection to the SQLite database.
void	setErrorOutput(boolean errors) Sets whether or not to print errors to the console automatically.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codelanx.codelanxlib.data.SQLDataType

batchUpdate, commit, isAutoCommit, operate, prepare, query, query, rollback, setAutoCommit, update

Field Detail

connections

protected static byte connections

The number of connections in use by this data type

con

protected Connection con

The Connection object

Constructor Detail

SQLite

public SQLite()

Method Detail

open

public Connection open(Plugin plugin)
                throws SQLException

Opens a connection to the SQLite database. Make sure to call close() after you are finished working with the database for your segment of your code.

Parameters:

plugin - The Plugin with the data folder to use

Returns:

The established Connection

Throws:

SQLException - If the connection fails to open

Since:

0.1.0

open

public Connection open(Plugin plugin,
                       String name)
                throws SQLException

Opens a connection to the SQLite database. Make sure to call close() after you are finished working with the database for your segment of your code.

Parameters:

plugin - The Plugin with the data folder to use

name - The name of the database file

Returns:

The established Connection

Throws:

SQLException - If the connection fails to open

Since:

0.1.0

open

public Connection open(File folder,
                       String name)
                throws SQLException

Opens a connection to the SQLite database. Make sure to call close() after you are finished working with the database for your segment of your code.

Parameters:

folder - A File pointing to a data folder for the database

name - The name of the database file

Returns:

The established Connection

Throws:

SQLException - If the connection fails to open

Since:

0.1.0

open

public Connection open(File database)
                throws SQLException

Opens a connection to the SQLite database. Make sure to call close() after you are finished working with the database for your segment of your code.

Parameters:

database - A File that represents the database location

Returns:

The established Connection

Throws:

SQLException - If the connection fails to open

Since:

0.2.0

checkTable

public boolean checkTable(String tableName)

Checks if a table exists within the set database

Specified by:

checkTable in interface SQLDataType

Parameters:

tableName - Name of the table to check for

Returns:

true if exists, false otherwise

Since:

0.1.0

checkColumn

public boolean checkColumn(String tableName,
                           String columnName)

Checks if a table has the following column

Specified by:

checkColumn in interface SQLDataType

Parameters:

tableName - The table to look in

columnName - The column to search for

Returns:

true if the column exists

Since:

0.1.0

setErrorOutput

public void setErrorOutput(boolean errors)

Description copied from interface: SQLDataType

Sets whether or not to print errors to the console automatically. This is defaulted to true

Specified by:

setErrorOutput in interface SQLDataType

Parameters:

errors - false to disable error output

isSendingErrorOutput

public boolean isSendingErrorOutput()

Description copied from interface: SQLDataType

Determines whether or not to automatically print errors to the console

Specified by:

isSendingErrorOutput in interface SQLDataType

Returns:

true if content is printed to the console.

close

public void close()

Closes the SQLite connection. Must be open first.

Specified by:

close in interface SQLDataType

Specified by:

close in interface AutoCloseable

Since:

0.1.0

getConnection

public Connection getConnection()

Returns the Connection object for ease of use in exposing more internal API

Specified by:

getConnection in interface SQLDataType

Returns:

The Connection object in use by this SQLDataType

Since:

0.1.0