Module watamebot

Package net.foxgenesis.database

Class DatabaseManager

java.lang.Object

net.foxgenesis.database.DatabaseManager

All Implemented Interfaces:

AutoCloseable, IDatabaseManager

public class DatabaseManager
extends Object
implements IDatabaseManager, AutoCloseable

NEED_JAVADOC

Author:

Ashley

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DatabaseManager(@NotNull String name)	NEED_JAVADOC

Method Summary

Modifier and Type	Method	Description
void	close()
@NotNull String	getName()	Get the name of this instance.
boolean	isDatabaseRegistered(AbstractDatabase database)	Check if an AbstractDatabase is registered in this manager.
boolean	isReady()	Check if all guild data has been processed and is ready for use.
boolean	register(@NotNull Plugin plugin, @NotNull AbstractDatabase database)	Register an AbstractDatabase that a Plugin requires.
void	start(@NotNull AConnectionProvider provider)
CompletableFuture<Void>	start(@NotNull AConnectionProvider provider, Executor executor)
boolean	unload(Plugin owner)	NEED_JAVADOC

Methods inherited from class java.lang.Object

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

Field Details

logger

@NotNull
protected final @NotNull org.slf4j.Logger logger

Constructor Details

DatabaseManager

public DatabaseManager(@NotNull
 @NotNull String name)

NEED_JAVADOC

Parameters:

name -

Method Details

register

public boolean register(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull AbstractDatabase database)
                 throws IOException

Description copied from interface: IDatabaseManager

Register an AbstractDatabase that a Plugin requires.

Specified by:

register in interface IDatabaseManager

Parameters:

plugin - - owner of the instance

database - - database to register

Returns:

Returns true if the database was registered. false otherwise.

Throws:

IOException - Thrown if there was an error while reading database setup files

unload

public boolean unload(Plugin owner)

NEED_JAVADOC

Parameters:

owner -

Returns:

Returns true if all databases from the owner have been unloaded. false otherwise

isDatabaseRegistered

public boolean isDatabaseRegistered(AbstractDatabase database)

Description copied from interface: IDatabaseManager

Check if an AbstractDatabase is registered in this manager.

Specified by:

isDatabaseRegistered in interface IDatabaseManager

Parameters:

database - - the database to check if it exists

Returns:

Returns true if the database is registered, false otherwise.

start

public CompletableFuture<Void> start(@NotNull
 @NotNull AConnectionProvider provider,
 Executor executor)

start

public void start(@NotNull
 @NotNull AConnectionProvider provider)

isReady

public boolean isReady()

Description copied from interface: IDatabaseManager

Check if all guild data has been processed and is ready for use.

Specified by:

isReady in interface IDatabaseManager

Returns:

Returns true when all data has been loaded from the database

getName

@NotNull
public @NotNull String getName()

Description copied from interface: IDatabaseManager

Get the name of this instance.

Specified by:

getName in interface IDatabaseManager

Returns:

Returns the name of this instance.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception