Package com.chillycheesy.modulo.modules

Class ModuleAdapter

java.lang.Object

com.chillycheesy.modulo.modules.ModuleEntityAdapter

com.chillycheesy.modulo.config.ConfigurableEntity

com.chillycheesy.modulo.modules.Module

com.chillycheesy.modulo.modules.ModuleAdapter

All Implemented Interfaces:

ModuloEntity

public class ModuleAdapter
extends Module

HTModuleAdapter is just a Module with a default implementation of the onLoad() onStart() onStop() methods.
You can extend of this class to create your module but you'll have to override those methods by yourself (override those method if you need them)

Field Summary

Fields inherited from class com.chillycheesy.modulo.config.ConfigurableEntity

autoSave, configurationFactory, defaultConfiguration, loaderStrategy

Constructor Summary

Constructors

Constructor	Description
ModuleAdapter()
ModuleAdapter(ModuleConfig config)	Init your module by passing the ModuleConfig object
ModuleAdapter(String name, String version, List<String> authors, List<String> dependencies, List<String> softDependencies, String main)

Method Summary

Modifier and Type	Method	Description
protected <E extends Throwable> void	onLoad()	Method called when the Module.load() method is called
protected <E extends Throwable> void	onStart()	Method called when the Module.start() method is called
protected <E extends Throwable> void	onStop()	Method called when the Module.stop() method is called

Methods inherited from class com.chillycheesy.modulo.modules.Module

debug, equals, error, getAuthors, getConfig, getDependencies, getJarFile, getMain, getName, getSoftDependencies, getVersion, info, load, setAuthors, setConfig, setDependencies, setJarFile, setMain, setName, setSoftDependencies, setVersion, start, stop

Methods inherited from class com.chillycheesy.modulo.config.ConfigurableEntity

enableAutoSave, getConfiguration, getConfigurationFactory, getLoaderStrategy, load, setConfiguration, setConfigurationFactory

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleAdapter

public ModuleAdapter(String name,
 String version,
 List<String> authors,
 List<String> dependencies,
 List<String> softDependencies,
 String main)

Parameters:

name - it's how your HTModule will be call by HomeTracker
note that two HTModules can't have the same name (you won't be able to add it to the ModuleManager

version - the actual version of your module

authors - the list of persons that works on your module

dependencies - the list of modules that your module need to work, the dependencies will be load before your module get load by the ModuleLoader (your module cannot load without them)

softDependencies - the list of modules that your module can use to work with but without being an obligation (your module can load without them)

main - the main file of your jar (example: com.dev.MyAwesomeModule)

ModuleAdapter

public ModuleAdapter(ModuleConfig config)

Init your module by passing the ModuleConfig object

Parameters:

config - the configuration of your module

ModuleAdapter

public ModuleAdapter()

Method Details

onLoad

protected <E extends Throwable> void onLoad()
                                     throws E

Method called when the Module.load() method is called

Specified by:

onLoad in class Module

Throws:

E extends Throwable

onStart

protected <E extends Throwable> void onStart()
                                      throws E

Method called when the Module.start() method is called

Specified by:

onStart in class Module

Throws:

E extends Throwable

onStop

protected <E extends Throwable> void onStop()
                                     throws E

Method called when the Module.stop() method is called

Specified by:

onStop in class Module

Throws:

E extends Throwable