me.piggypiglet.framework

Class Framework.FrameworkBuilder

java.lang.Object

me.piggypiglet.framework.Framework.FrameworkBuilder

Enclosing class:

Framework

public static final class Framework.FrameworkBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Framework	build() Compile all the user-set options into an instance of Framework NOTE: Will crash if any of the following aren't set: - main - pckg
Framework.FrameworkBuilder	commandPrefix(java.lang.String commandPrefix) The application's command prefix, to be used in command handlers.
Framework.FrameworkBuilder	config(java.lang.Class<?> addon, java.lang.String config, java.util.Map<java.lang.String,java.lang.String> locations) Configure a config for an addon that requires configuration.
Framework.FrameworkBuilder	customLang(java.lang.String config, LangEnum[] values) Specify a custom language enum
Framework.FrameworkBuilder	debug(boolean debug) Should debug messages be logged?
Framework.FrameworkBuilder	file(boolean config, java.lang.String name, FileData.ConfigPathReference internalPath, java.lang.String externalPath, java.lang.annotation.Annotation annotation) Add a file to be copied from an embed and loaded into memory.
Framework.FrameworkBuilder	file(boolean config, java.lang.String name, FileData.ConfigPathReference internalPath, java.lang.String externalPath, java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Add a file to be copied from an embed and loaded into memory.
Framework.FrameworkBuilder	file(boolean config, java.lang.String name, java.lang.String internalPath, java.lang.String externalPath, java.lang.annotation.Annotation annotation) Add a file to be copied from an embed and loaded into memory.
Framework.FrameworkBuilder	file(boolean config, java.lang.String name, java.lang.String internalPath, java.lang.String externalPath, java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Add a file to be copied from an embed and loaded into memory.
Framework.FrameworkBuilder	fileDir(java.lang.String dir) Set the parent directory configs will be put in.
Framework.FrameworkBuilder	injector(com.google.inject.Injector injector) Set the application's initial injector, if one is already made.
Framework.FrameworkBuilder	langConfig(java.lang.String config, java.util.Map<java.lang.String,java.lang.String> locations) If useLangFile is set to true, optionally use your own config with mappings.
Framework.FrameworkBuilder	main(java.lang.Class<?> clazz, java.lang.Object instance) Set the application's main instance
Framework.FrameworkBuilder	main(java.lang.Object instance) Set the application's main instance
Framework.FrameworkBuilder	overrideLangFile(boolean value) Declare whether a lang file will be used over hardcoded values.
Framework.FrameworkBuilder	pckg(java.lang.String pckg, java.lang.String... exclusions) Set the application's package which will be scanned, and optionally any sub packages to exclude.
Framework.FrameworkBuilder	shutdown(java.lang.Class<? extends ShutdownRegisterable>... registerables) Add shutdown registerables to be ran in the shutdown hook, in order.
Framework.FrameworkBuilder	startup(RegisterableData... registerables) Add startup registerables to be ran in the bootstrap, in order.
Framework.FrameworkBuilder	threads(int threads) Set the amount of threads that will be available via the default task manager's thread pol

Methods inherited from class java.lang.Object

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

Method Detail

main

public final Framework.FrameworkBuilder main(java.lang.Object instance)

Set the application's main instance

Parameters:

instance - Main instance

Returns:

FrameworkBuilder

main

public final Framework.FrameworkBuilder main(java.lang.Class<?> clazz,
                                             java.lang.Object instance)

Set the application's main instance

Parameters:

clazz - Class to bind the instance under, for example, in bukkit, you'd enter JavaPlugin.class

instance - Main instance

Returns:

FrameworkBuilder

pckg

public final Framework.FrameworkBuilder pckg(java.lang.String pckg,
                                             java.lang.String... exclusions)

Set the application's package which will be scanned, and optionally any sub packages to exclude.

Parameters:

pckg - Application's package

exclusions - Packages to be excluded

Returns:

FrameworkBuilder

injector

public final Framework.FrameworkBuilder injector(com.google.inject.Injector injector)

Set the application's initial injector, if one is already made.

Parameters:

injector - Application's injector

Returns:

FrameworkBuilder

startup

public final Framework.FrameworkBuilder startup(RegisterableData... registerables)

Add startup registerables to be ran in the bootstrap, in order.

Parameters:

registerables - Varargs classes extending StartupRegisterable

Returns:

FrameworkBuilder

shutdown

@SafeVarargs
public final Framework.FrameworkBuilder shutdown(java.lang.Class<? extends ShutdownRegisterable>... registerables)

Add shutdown registerables to be ran in the shutdown hook, in order.

Parameters:

registerables - Varargs classes extending ShutdownRegisterable

Returns:

FrameworkBuilder

commandPrefix

public final Framework.FrameworkBuilder commandPrefix(java.lang.String commandPrefix)

The application's command prefix, to be used in command handlers.

Parameters:

commandPrefix - String

Returns:

FrameworkBuilder

file

public final Framework.FrameworkBuilder file(boolean config,
                                             java.lang.String name,
                                             java.lang.String internalPath,
                                             java.lang.String externalPath,
                                             java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Add a file to be copied from an embed and loaded into memory.

Parameters:

config - Should this file be stored as a FileConfiguration

name - Name of the file to be referenced in FileManager

internalPath - The hard internal path of the file.

externalPath - The external path of the file, set to null if file shouldn't be copied outside the jar.

annotation - Annotation class to bind the instance to.

Returns:

FrameworkBuilder

file

public final Framework.FrameworkBuilder file(boolean config,
                                             java.lang.String name,
                                             java.lang.String internalPath,
                                             java.lang.String externalPath,
                                             java.lang.annotation.Annotation annotation)

Add a file to be copied from an embed and loaded into memory.

Parameters:

config - Should this file be stored as a FileConfiguration

name - Name of the file to be referenced in FileManager

internalPath - The hard internal path of the file.

externalPath - The external path of the file, set to null if file shouldn't be copied outside the jar.

annotation - Annotation instance to bind the instance to.

Returns:

FrameworkBuilder

file

public final Framework.FrameworkBuilder file(boolean config,
                                             java.lang.String name,
                                             FileData.ConfigPathReference internalPath,
                                             java.lang.String externalPath,
                                             java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Add a file to be copied from an embed and loaded into memory.

Parameters:

config - Should this file be stored as a FileConfiguration

name - Name of the file to be referenced in FileManager

internalPath - The dynamic internal path of the file.

externalPath - The external path of the file, set to null if file shouldn't be copied outside the jar.

annotation - Annotation class to bind the instance to.

Returns:

FrameworkBuilder

file

public final Framework.FrameworkBuilder file(boolean config,
                                             java.lang.String name,
                                             FileData.ConfigPathReference internalPath,
                                             java.lang.String externalPath,
                                             java.lang.annotation.Annotation annotation)

Add a file to be copied from an embed and loaded into memory.

Parameters:

config - Should this file be stored as a FileConfiguration

name - Name of the file to be referenced in FileManager

internalPath - The dynamic internal path of the file.

externalPath - The external path of the file, set to null if file shouldn't be copied outside the jar.

annotation - Annotation instance to bind the instance to.

Returns:

FrameworkBuilder

threads

public final Framework.FrameworkBuilder threads(int threads)

Set the amount of threads that will be available via the default task manager's thread pol

Parameters:

threads - Amount of threads

Returns:

FrameworkBuilder

config

public final Framework.FrameworkBuilder config(java.lang.Class<?> addon,
                                               java.lang.String config,
                                               java.util.Map<java.lang.String,java.lang.String> locations)

Configure a config for an addon that requires configuration. If not done manually, the addon will usually create it's own configuration file.

Parameters:

addon - Addon to configure

config - String reference to config in FileManager

locations - Locations of the values the addon needs

Returns:

FrameworkBuilder

fileDir

public final Framework.FrameworkBuilder fileDir(java.lang.String dir)

Set the parent directory configs will be put in. Don't include a file separator (/ or \) at the end.

Parameters:

dir - Path of the directory

Returns:

FrameworkBuilder

overrideLangFile

public final Framework.FrameworkBuilder overrideLangFile(boolean value)

Declare whether a lang file will be used over hardcoded values.

Parameters:

value - True or false

Returns:

FrameworkBuilder

langConfig

public final Framework.FrameworkBuilder langConfig(java.lang.String config,
                                                   java.util.Map<java.lang.String,java.lang.String> locations)

If useLangFile is set to true, optionally use your own config with mappings.

Parameters:

config - Config name

locations - Mapping

Returns:

FrameworkBuilder

customLang

public final Framework.FrameworkBuilder customLang(java.lang.String config,
                                                   LangEnum[] values)

Specify a custom language enum

Parameters:

config - Config identifier

values - Values of the enum

Returns:

FrameworkBuilder

debug

public final Framework.FrameworkBuilder debug(boolean debug)

Should debug messages be logged?

Parameters:

debug - True/false

Returns:

FrameworkBuilder

build

public final Framework build()

Compile all the user-set options into an instance of Framework NOTE: Will crash if any of the following aren't set: - main - pckg

Returns:

Framework instance