Package io.github.mrtesz.teszcore.api

Class TeszCoreApi

java.lang.Object

io.github.mrtesz.teszcore.api.TeszCoreApi

All Implemented Interfaces:

Copyable<TeszCoreApi>

public class TeszCoreApi
extends Object
implements Copyable<TeszCoreApi>

The API class

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TeszCoreApi.Initializer

Method Summary

Modifier and Type	Method	Description
TeszCoreApi	copy()	Copy the executing class
MariaDBManager	createMariaDBManager(@Nullable String projectName, boolean infoWhenCredentialsAreNull, @Nullable String name, String url, String user, String password)	Creates a MariaDBManager for your project
MariaDBManager	createMariaDBManager(@Nullable String projectName, boolean infoWhenCredentialsAreNull, String url, String user, String password)	Creates a MariaDBManager for your project
SqliteManager	createSqliteManager(@Nullable String projectName, @Nullable String path, @NotNull String fileName)	Creates a SqliteManager for your Project
static TeszCoreApi	getInstance()	Get the current instance
org.apache.logging.log4j.Logger	getLog4jLogger()	Get the Logger, TeszCore uses internally
TeszCoreLogger	getLogger(@NotNull DebugLevel debugLevel)	Creates a TeszCoreLogger
TeszCoreLogger	getLogger(@NotNull DebugLevel debugLevel, @Nullable String projectName)	Creates a TeszCoreLogger with project name for specific logs
org.apache.logging.log4j.core.LoggerContext	getLoggerContext()	Get the LoggerContext, the log4j.Logger uses
static TeszCoreApi	initialize(TeszCoreApi.Initializer initializer)	Create a new TeszCoreApi instance
void	logException(@NotNull Throwable throwable)	Logs a throwable by calling TeszCoreLogger.printStackTrace(java.lang.Throwable)

Methods inherited from class java.lang.Object

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

Method Details

initialize

public static TeszCoreApi initialize(TeszCoreApi.Initializer initializer)
                              throws DuplicateInitializationException

Create a new TeszCoreApi instance

Parameters:

initializer - Initializer class (previously created with the

invalid reference

Initializer#builder()

)

Returns:

The created TeszCoreApi instance (can also be obtained with getInstance()

Throws:

DuplicateInitializationException - when a TeszCoreApi instance was already initialized by other projects (can be bypassed with setting TeszCoreApi.Initializer.overwrite to true)

logException

public void logException(@NotNull
 @NotNull Throwable throwable)

Logs a throwable by calling TeszCoreLogger.printStackTrace(java.lang.Throwable)

Parameters:

throwable - The throwable to log

getLogger

public TeszCoreLogger getLogger(@NotNull
 @NotNull DebugLevel debugLevel)

Creates a TeszCoreLogger

Parameters:

debugLevel - Level of Logging used for your Message

Returns:

a new TeszCoreLogger

getLogger

public TeszCoreLogger getLogger(@NotNull
 @NotNull DebugLevel debugLevel,
 @Nullable
 @Nullable String projectName)

Creates a TeszCoreLogger with project name for specific logs

Parameters:

debugLevel - Level of Logging used for your Message

projectName - The name of the project, using the logger

Returns:

a new TeszCoreLogger

createMariaDBManager

public MariaDBManager createMariaDBManager(@Nullable
 @Nullable String projectName,
 boolean infoWhenCredentialsAreNull,
 @Nullable
 @Nullable String name,
 String url,
 String user,
 String password)

Creates a MariaDBManager for your project

Parameters:

projectName - Name of the project using the method

infoWhenCredentialsAreNull - throw an error, if url, user or password is null/blank

name - Name of the database manager Default: "Main"

url - Url of the database, connecting to

user - Username of the user, connecting with

password - Password of the user, connecting with

Returns:

a MariaDBManager

createMariaDBManager

public MariaDBManager createMariaDBManager(@Nullable
 @Nullable String projectName,
 boolean infoWhenCredentialsAreNull,
 String url,
 String user,
 String password)

Creates a MariaDBManager for your project

Parameters:

projectName - Name of the project using the method

infoWhenCredentialsAreNull - throw an error, if url, user or password is null/blank

url - Url of the database, connecting to

user - Username of the user, connecting with

password - Password of the user, connecting with

Returns:

a MariaDBManager

createSqliteManager

public SqliteManager createSqliteManager(@Nullable
 @Nullable String projectName,
 @Nullable
 @Nullable String path,
 @NotNull
 @NotNull String fileName)

Creates a SqliteManager for your Project

Parameters:

projectName - The name of the Project using the method

path - Path of the `.db` file — `null` uses the default location

fileName - Name of the `.db` file

Returns:

a SqliteManager

getLog4jLogger

public org.apache.logging.log4j.Logger getLog4jLogger()

Get the Logger, TeszCore uses internally

Returns:

the Logger, TeszCore uses internally

getLoggerContext

public org.apache.logging.log4j.core.LoggerContext getLoggerContext()

Get the LoggerContext, the log4j.Logger uses

Returns:

the LoggerContext, the log4j.Logger uses

getInstance

public static TeszCoreApi getInstance()
                               throws NullPointerException

Get the current instance

Returns:

Current TeszCoreApi instance

Throws:

NullPointerException - if the TeszCoreApi was not initialized before with initialize(Initializer)

copy

public TeszCoreApi copy()
                 throws DuplicateInitializationException,
IllegalArgumentException

Description copied from interface: Copyable

Copy the executing class

Specified by:

copy in interface Copyable<TeszCoreApi>

Returns:

a copy of the class executed in

Throws:

DuplicateInitializationException

IllegalArgumentException