Package xyz.srnyx.annoyingapi.storage

Class StorageConfig

java.lang.Object

xyz.srnyx.annoyingapi.storage.StorageConfig

public class StorageConfig
extends Object

The storage.yml configuration file parser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StorageConfig.Cache	Options for the data cache (stored differently per method)
class	StorageConfig.RemoteConnection	The remote connection details/properties
static enum	StorageConfig.SaveOn	Valid values for storage.yml's cache.save-on option

Field Summary

Fields

Modifier and Type	Field	Description
final @NotNull StorageConfig.Cache	cache	The data cache options
final @NotNull AnnoyingFile<?>	file	The storage configuration file
final @NotNull StorageMethod	method	The storage method
final @NotNull String	migrationLogPrefix	Friendly name when migrating between methods for logging Format: FILE_PATH (METHOD)
final @Nullable StorageConfig.RemoteConnection	remoteConnection	The remote connection details/properties

Constructor Summary

Constructors

Constructor	Description
StorageConfig(@NotNull AnnoyingFile<?> file)	Construct a new StorageConfig instance to parse a storage configuration file

Method Summary

Modifier and Type	Method	Description
@NotNull Connection	createConnection()	Create a new Connection to the configured database

Methods inherited from class java.lang.Object

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

Field Details

file

@NotNull
public final @NotNull AnnoyingFile<?> file

The storage configuration file

method

@NotNull
public final @NotNull StorageMethod method

The storage method

cache

@NotNull
public final @NotNull StorageConfig.Cache cache

The data cache options

remoteConnection

@Nullable
public final @Nullable StorageConfig.RemoteConnection remoteConnection

The remote connection details/properties

migrationLogPrefix

@NotNull
public final @NotNull String migrationLogPrefix

Friendly name when migrating between methods for logging
Format: FILE_PATH (METHOD)

Constructor Details

StorageConfig

public StorageConfig(@NotNull
 @NotNull AnnoyingFile<?> file)

Construct a new StorageConfig instance to parse a storage configuration file

Parameters:

file - file

Method Details

createConnection

@NotNull
public @NotNull Connection createConnection()
                                     throws ConnectionException

Create a new Connection to the configured database

Returns:

a new Connection to the database

Throws:

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