Module watamebot

Package net.foxgenesis.watame.sql

Class WatameBotDatabase

java.lang.Object

net.foxgenesis.database.AbstractDatabase

net.foxgenesis.watame.sql.WatameBotDatabase

All Implemented Interfaces:

AutoCloseable, IPropertyProvider<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>, IGuildDataProvider

public class WatameBotDatabase
extends AbstractDatabase
implements IGuildDataProvider, IPropertyProvider<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Nested Class Summary

Nested classes/interfaces inherited from class net.foxgenesis.database.AbstractDatabase

AbstractDatabase.SQLConsumer<U>, AbstractDatabase.SQLFunction<U,V>

Constructor Summary

Constructors

Constructor	Description
WatameBotDatabase()

Method Summary

Modifier and Type	Method	Description
void	addGuild(net.dv8tion.jda.api.entities.Guild guild)	Register a guild to be loaded during data retrieval.
void	close()
IGuildData	getDataForGuild(net.dv8tion.jda.api.entities.Guild guild)	NEED_JAVADOC
IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>	getProperty(String key)	Get a property field associated with a specified key.
boolean	isPropertyPresent(String key)	Check if the property associated with the specified key has already been constructed.
protected void	onReady()
void	removeGuild(net.dv8tion.jda.api.entities.Guild guild)	Remove a guild from the data manager.

Methods inherited from class net.foxgenesis.database.AbstractDatabase

getName, getRawStatement, hasStatementID, isReady, mapCallable, mapStatement, openConnection, prepareCallable, prepareCallableAsync, prepareStatement, prepareStatementAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.foxgenesis.watame.sql.IGuildDataProvider

isReady

Constructor Details

WatameBotDatabase

public WatameBotDatabase()

Method Details

addGuild

public void addGuild(@Nonnull
 net.dv8tion.jda.api.entities.Guild guild)

Register a guild to be loaded during data retrieval.

Parameters:

guild - - Guild to be loaded

Throws:

NullPointerException - if guild is null

See Also:

• removeGuild(Guild)

removeGuild

public void removeGuild(@Nonnull
 net.dv8tion.jda.api.entities.Guild guild)

Remove a guild from the data manager.

Parameters:

guild - - Guild to be removed

Throws:

NullPointerException - if guild is null

See Also:

• addGuild(Guild)

getDataForGuild

@Nullable
public IGuildData getDataForGuild(@Nonnull
 net.dv8tion.jda.api.entities.Guild guild)

Description copied from interface: IGuildDataProvider

NEED_JAVADOC

Specified by:

getDataForGuild in interface IGuildDataProvider

Returns:

getProperty

public IPropertyField<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping> getProperty(@Nonnull
 String key)

Description copied from interface: IPropertyProvider

Get a property field associated with a specified key.

Specified by:

getProperty in interface IPropertyProvider<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Parameters:

key - - the property's key

Returns:

Returns an IPropertyField pointing to the specified key

isPropertyPresent

public boolean isPropertyPresent(@Nonnull
 String key)

Description copied from interface: IPropertyProvider

Check if the property associated with the specified key has already been constructed.

Specified by:

isPropertyPresent in interface IPropertyProvider<String,net.dv8tion.jda.api.entities.Guild,IGuildPropertyMapping>

Parameters:

key - - the property's key

Returns:

Returns true if the property's key has already been registered/constructed.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

onReady

protected void onReady()

Specified by:

onReady in class AbstractDatabase