Package xyz.srnyx.annoyingapi.storage

Class DataManager

java.lang.Object

xyz.srnyx.annoyingapi.storage.DataManager

public class DataManager
extends Object

The data manager for the plugin, used to manage the connection and data storage

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable TaskWrapper	cacheSavingTask	The task that saves the cache on an interval
final @NotNull Dialect	dialect	The dialect for the database
final @NotNull AnnoyingPlugin	plugin	The plugin to use for the data manager
final @NotNull StorageConfig	storageConfig	The storage.yml config for the plugin
final @NotNull String	tablePrefix	The table prefix for the database (only for remote connections)

Constructor Summary

Constructors

Constructor	Description
DataManager(@NotNull StorageConfig config)	Connect to the configured database and create the pre-defined tables/columns

Method Summary

Modifier and Type	Method	Description
@NotNull DataManager	attemptDatabaseMigration()	Attempts to migrate data from storage.yml to storage-new.yml
@NotNull String	getTableName(@NotNull String tableName)	Get the full name of a table with the prefix This just returns the table name if it's a local database or there isn't prefix
void	toggleIntervalCacheSaving()	If saving the cache on an interval is enabled, this will start the asynchronous task to do that If the feature is disabled, this will cancel the task if it exists

Methods inherited from class java.lang.Object

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

Field Details

plugin

@NotNull
public final @NotNull AnnoyingPlugin plugin

The plugin to use for the data manager

storageConfig

@NotNull
public final @NotNull StorageConfig storageConfig

The storage.yml config for the plugin

dialect

@NotNull
public final @NotNull Dialect dialect

The dialect for the database

tablePrefix

@NotNull
public final @NotNull String tablePrefix

The table prefix for the database (only for remote connections)

cacheSavingTask

@Nullable
public @Nullable TaskWrapper cacheSavingTask

The task that saves the cache on an interval

See Also:

• toggleIntervalCacheSaving()

Constructor Details

DataManager

public DataManager(@NotNull
 @NotNull StorageConfig config)
            throws ConnectionException

Connect to the configured database and create the pre-defined tables/columns

Parameters:

config - the storage.yml config to use for the data manager

Throws:

ConnectionException - if the connection to the database fails for any reason

Method Details

getTableName

@NotNull
public @NotNull String getTableName(@NotNull
 @NotNull String tableName)

Get the full name of a table with the prefix
This just returns the table name if it's a local database or there isn't prefix

Parameters:

tableName - the name of the table to get

Returns:

the full name of the table

toggleIntervalCacheSaving

public void toggleIntervalCacheSaving()

If saving the cache on an interval is enabled, this will start the asynchronous task to do that
If the feature is disabled, this will cancel the task if it exists

attemptDatabaseMigration

@NotNull
public @NotNull DataManager attemptDatabaseMigration()

Attempts to migrate data from storage.yml to storage-new.yml

Returns:

the new data manager