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>, IGuildPropertyProvider, IGuildDataProvider

public class WatameBotDatabase
extends AbstractDatabase
implements IGuildDataProvider, IGuildPropertyProvider

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(long id)	Register a guild to be loaded during data retrieval.
void	addGuild(net.dv8tion.jda.api.entities.Guild guild)	Deprecated, for removal: This API element is subject to removal in a future version.
void	close()
IGuildData	getDataForGuild(net.dv8tion.jda.api.entities.Guild guild)	NEED_JAVADOC
GuildProperty	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.
Set<String>	keySet()	Get a set of all registered keys this provider has constructed.
protected void	onReady()	NEED_JAVADOC
void	removeGuild(long id)	Remove a guild from the data manager.
void	removeGuild(net.dv8tion.jda.api.entities.Guild guild)	Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true)
public void addGuild(@Nonnull
 net.dv8tion.jda.api.entities.Guild guild)

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true)
public void removeGuild(@Nonnull
 net.dv8tion.jda.api.entities.Guild guild)

Deprecated, for removal: This API element is subject to removal in a future version.

Remove a guild from the data manager.

Parameters:

guild - - Guild to be removed

Throws:

NullPointerException - if guild is null

See Also:

• addGuild(Guild)

addGuild

public void addGuild(long id)

Register a guild to be loaded during data retrieval.

NOTE: This contains a ForkJoinPool.ManagedBlocker!

Parameters:

id - - guild ID to be removed

Throws:

IllegalArgumentException - if id is 0

See Also:

• removeGuild(long)

removeGuild

public void removeGuild(long id)

Remove a guild from the data manager.

Parameters:

id - - guild ID to be removed

Throws:

IllegalArgumentException - if id is 0

See Also:

• addGuild(long)

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 GuildProperty 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 ImmutableProperty 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()

Specified by:

close in interface AutoCloseable

onReady

protected void onReady()

Description copied from class: AbstractDatabase

NEED_JAVADOC

Specified by:

onReady in class AbstractDatabase

keySet

@Nonnull
public Set<String> keySet()

Description copied from interface: IPropertyProvider

Get a set of all registered keys this provider has constructed.

Specified by:

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

Returns:

Returns a Set of IPropertyProvider