pro.gravit.launcher.modules

Class LauncherModule

java.lang.Object

pro.gravit.launcher.modules.LauncherModule

public abstract class LauncherModule
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LauncherModule.Event
static interface	LauncherModule.EventHandler<T extends LauncherModule.Event>
static class	LauncherModule.InitStatus Module initialization status at the current time

Field Summary

Fields

Modifier and Type	Field and Description
protected LauncherModule.InitStatus	initStatus
protected LauncherModuleInfo	moduleInfo
protected ModulesConfigManager	modulesConfigManager
protected LauncherModulesManager	modulesManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LauncherModule()
protected	LauncherModule(LauncherModuleInfo info)

Method Summary

Modifier and Type	Method and Description
<T extends LauncherModule.Event> void	callEvent(T event) Call the handler of the current module
LauncherModule.InitStatus	getInitStatus()
LauncherModuleInfo	getModuleInfo()
abstract void	init(LauncherInitContext initContext) Basic module initialization method You can: - Subscribe to events - Use your dependencies - Use provided initContext - Receive modules and access the module’s internal methods You can not: - Modify module description, dependencies - Add modules - Read configuration
LauncherModule	preInit()
void	preInitAction() This method is called before initializing all modules and resolving dependencies.
protected <T extends LauncherModule.Event> boolean	registerEvent(LauncherModule.EventHandler<T> handle, java.lang.Class<T> tClass) Registers an event handler for the current module
void	setContext(LauncherModulesContext context) The internal method used by the ModuleManager DO NOT TOUCH
LauncherModule	setInitStatus(LauncherModule.InitStatus initStatus)

Methods inherited from class java.lang.Object

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

Field Detail

modulesManager

protected LauncherModulesManager modulesManager

moduleInfo

protected final LauncherModuleInfo moduleInfo

modulesConfigManager

protected ModulesConfigManager modulesConfigManager

initStatus

protected LauncherModule.InitStatus initStatus

Constructor Detail

LauncherModule

protected LauncherModule()

LauncherModule

protected LauncherModule(LauncherModuleInfo info)

Method Detail

getModuleInfo

public LauncherModuleInfo getModuleInfo()

getInitStatus

public LauncherModule.InitStatus getInitStatus()

setInitStatus

public LauncherModule setInitStatus(LauncherModule.InitStatus initStatus)

setContext

public void setContext(LauncherModulesContext context)

The internal method used by the ModuleManager DO NOT TOUCH

Parameters:

context - Private context

preInitAction

public void preInitAction()

This method is called before initializing all modules and resolving dependencies. You can: - Use to Module Manager - Add custom modules not described in the manifest - Change information about your module or modules you control You can not: - Use your dependencies - Use Launcher, LaunchServer, ServerWrapper API - Change the names of any modules

preInit

public LauncherModule preInit()

init

public abstract void init(LauncherInitContext initContext)

Basic module initialization method You can: - Subscribe to events - Use your dependencies - Use provided initContext - Receive modules and access the module’s internal methods You can not: - Modify module description, dependencies - Add modules - Read configuration

Parameters:

initContext - null on module initialization during boot or startup Not null during module initialization while running

registerEvent

protected <T extends LauncherModule.Event> boolean registerEvent(LauncherModule.EventHandler<T> handle,
                                                                 java.lang.Class<T> tClass)

Registers an event handler for the current module

Type Parameters:

T - event type

Parameters:

handle - your event handler

tClass - event class

Returns:

true if adding a handler was successful

callEvent

public final <T extends LauncherModule.Event> void callEvent(T event)

Call the handler of the current module

Type Parameters:

T - event type

Parameters:

event - event handled