me.piggypiglet.framework

Class Framework

java.lang.Object

me.piggypiglet.framework.Framework

public final class Framework
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Framework.FrameworkBuilder

Method Summary

Modifier and Type	Method and Description
static Framework.FrameworkBuilder	builder() Initialize a new instance of FrameworkBuilder
java.lang.String	getCommandPrefix() Get the application's main command prefix.
java.util.Map<java.lang.Class<?>,ConfigInfo>	getConfigs() Get user defined configs for addons
CustomLang	getCustomLang() Custom language data, not necessarily related to overriding defaults.
java.lang.String	getFileDir() Get the directory files will be put in.
java.util.List<FileData>	getFiles() Get information on all files that need to be made
com.google.inject.Injector	getInjector() Get the project's initial injector
ConfigInfo	getLangConfig() Info about custom lang config, used if default is overridden.
MainBinding	getMain() Get the main instance
java.lang.String	getPckg() Get the projects package
java.lang.String[]	getPckgExclusions() Get any packages that should be excluded when scanning
java.util.List<java.lang.Class<? extends ShutdownRegisterable>>	getShutdownRegisterables() Get all manually inputted ShutdownRegisterables
java.util.List<RegisterableData>	getStartupRegisterables() Get all manually inputted StartupRegisterables
int	getThreads() Get the amount of threads to be stored in the default task manager's thread pool
FrameworkBootstrap	init() Start the bootstrap process with the current framework configuration.
boolean	isDebug() Whether to log debug messages.
boolean	overrideLangFile() Whether to override default language files with a custom one.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Framework.FrameworkBuilder builder()

Initialize a new instance of FrameworkBuilder

Returns:

FrameworkBuilder

init

public FrameworkBootstrap init()

Start the bootstrap process with the current framework configuration.

Returns:

FrameworkBootstrap instance

getMain

public MainBinding getMain()

Get the main instance

Returns:

MainBinding

getPckg

public java.lang.String getPckg()

Get the projects package

Returns:

String

getPckgExclusions

public java.lang.String[] getPckgExclusions()

Get any packages that should be excluded when scanning

Returns:

String array

getInjector

public com.google.inject.Injector getInjector()

Get the project's initial injector

Returns:

Injector

getStartupRegisterables

public java.util.List<RegisterableData> getStartupRegisterables()

Get all manually inputted StartupRegisterables

Returns:

Classes extending StartupRegisterable

getShutdownRegisterables

public java.util.List<java.lang.Class<? extends ShutdownRegisterable>> getShutdownRegisterables()

Get all manually inputted ShutdownRegisterables

Returns:

Classes extending ShutdownRegisterable

getCommandPrefix

public java.lang.String getCommandPrefix()

Get the application's main command prefix.

Returns:

String

getFiles

public java.util.List<FileData> getFiles()

Get information on all files that need to be made

Returns:

List of FileData

getThreads

public int getThreads()

Get the amount of threads to be stored in the default task manager's thread pool

Returns:

Amount of threads available in the thread pool

getConfigs

public java.util.Map<java.lang.Class<?>,ConfigInfo> getConfigs()

Get user defined configs for addons

Returns:

custom addon configs

getFileDir

public java.lang.String getFileDir()

Get the directory files will be put in.

Returns:

directory path

overrideLangFile

public boolean overrideLangFile()

Whether to override default language files with a custom one.

Returns:

boolean

getLangConfig

public ConfigInfo getLangConfig()

Info about custom lang config, used if default is overridden.

Returns:

ConfigInfo

getCustomLang

public CustomLang getCustomLang()

Custom language data, not necessarily related to overriding defaults.

Returns:

CustomLang

isDebug

public boolean isDebug()

Whether to log debug messages.

Returns:

boolean