Module watamebot

Package net.foxgenesis.database

Class AbstractDatabase

java.lang.Object

net.foxgenesis.database.AbstractDatabase

All Implemented Interfaces:

AutoCloseable

public abstract class AbstractDatabase
extends Object
implements AutoCloseable

NEED_JAVADOC

Author:

Ashley

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractDatabase.SQLConsumer<U>	NEED_JAVADOC
static interface	AbstractDatabase.SQLFunction<U,V>	NEED_JAVADOC

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger	Logger

Constructor Summary

Constructors

Constructor	Description
AbstractDatabase(@NotNull String name, @NotNull ModuleResource operationsFile, @NotNull ModuleResource setupFile)	NEED_JAVADOC

Method Summary

Modifier and Type	Method	Description
String	getDatabase()
final @NotNull String	getName()
protected final String	getRawStatement(String id)	NEED_JAVADOC
protected final boolean	hasStatementID(String id)	NEED_JAVADOC
boolean	isReady()	NEED_JAVADOC
protected <U> @Nullable Optional<U>	mapCallable(String id, AbstractDatabase.SQLFunction<CallableStatement,U> func)	NEED_JAVADOC
protected <U> @NotNull Optional<U>	mapStatement(String id, AbstractDatabase.SQLFunction<PreparedStatement,U> func, int... flags)	NEED_JAVADOC
protected abstract void	onReady()	NEED_JAVADOC
protected Connection	openConnection()	NEED_JAVADOC
protected void	prepareCallable(String id, AbstractDatabase.SQLConsumer<CallableStatement> func)	NEED_JAVADOC
protected void	prepareStatement(String id, AbstractDatabase.SQLConsumer<PreparedStatement> func, int... flags)	NEED_JAVADOC

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Details

logger

protected final org.slf4j.Logger logger

Logger

Constructor Details

AbstractDatabase

public AbstractDatabase(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull ModuleResource operationsFile,
 @NotNull
 @NotNull ModuleResource setupFile)

NEED_JAVADOC

Parameters:

name -

operationsFile -

setupFile -

Method Details

onReady

protected abstract void onReady()

NEED_JAVADOC

openConnection

protected Connection openConnection()
                             throws SQLException

NEED_JAVADOC

Returns:

Returns the new Connection

Throws:

SQLException

prepareStatement

protected void prepareStatement(String id,
 AbstractDatabase.SQLConsumer<PreparedStatement> func,
 int... flags)
                         throws SQLException

NEED_JAVADOC

Parameters:

id -

func -

flags -

Throws:

SQLException

prepareCallable

protected void prepareCallable(String id,
 AbstractDatabase.SQLConsumer<CallableStatement> func)
                        throws SQLException

NEED_JAVADOC

Parameters:

id -

func -

Throws:

SQLException

mapStatement

@NotNull
protected <U> @NotNull Optional<U> mapStatement(String id,
 AbstractDatabase.SQLFunction<PreparedStatement,U> func,
 int... flags)
                                         throws SQLException

NEED_JAVADOC

Type Parameters:

U -

Parameters:

id -

func -

flags -

Returns:

Returns the result of func otherwise an empty Optional

Throws:

SQLException

mapCallable

@Nullable
protected <U> @Nullable Optional<U> mapCallable(String id,
 AbstractDatabase.SQLFunction<CallableStatement,U> func)
                                         throws SQLException

NEED_JAVADOC

Type Parameters:

U -

Parameters:

id -

func -

Returns:

Returns the result of func otherwise an empty Optional

Throws:

SQLException

hasStatementID

protected final boolean hasStatementID(String id)

NEED_JAVADOC

Parameters:

id -

Returns:

Returns true if the statement is registered. false otherwise

getRawStatement

protected final String getRawStatement(String id)

NEED_JAVADOC

Parameters:

id -

Returns:

Returns the raw SQL statement

getName

@NotNull
public final @NotNull String getName()

isReady

public boolean isReady()

NEED_JAVADOC

Returns:

Returns true if the database is ready for use

getDatabase

public String getDatabase()