Package com.chillycheesy.modulo.modules

Class ModuleLoader

java.lang.Object

com.chillycheesy.modulo.modules.ModuleLoader

public class ModuleLoader
extends Object

Class that build and load all the Module in the modules folder.

Constructor Summary

Constructors

Constructor	Description
ModuleLoader()	Crate a new ModuleLoader.

Method Summary

Modifier and Type	Method	Description
List<Module>	getLoadedModules()	Get a list of loaded Module.
List<Module>	getStartedModule()	Get a list of started Module.
boolean	isValid(File file)	Check if a file is in the good format see ModuleBuilder for details.
boolean	isValid(String filepath)	Check if a jar file is in the good format see ModuleBuilder for details.
boolean	isValid(JarFile file)	Check if a jar file is in the good format see ModuleBuilder for details.
Module	loadModule(Module module)	Load a module already built It will call the load method of the module.
Module	loadModule(File file)	Load a module.
Module	loadModule(File file, URLClassLoader urlClassLoader)	Load a module.
void	loadModule(String filepath)	Load a module from a jar file path
List<Module>	loadModules(File file)	Load jar inside a folder if the jar was a module.
List<Module>	loadModules(String filepath)	Method call to load the jar files in a folder path.
void	startModule(Module module)
void	startModules()	Put and start all loaded modules in the ModuleManager.
void	startModules(List<Module> modules)

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleLoader

public ModuleLoader()

Crate a new ModuleLoader.

Method Details

loadModules

public List<Module> loadModules(File file)
                         throws FileIsNotAModuleDirectoryException,
IOException

Load jar inside a folder if the jar was a module. It will call the load method of the module.

Parameters:

file - folder to load.

Throws:

FileIsNotAModuleDirectoryException - If the target path was not a module directory.

IOException - If the file was not a JarFile.

loadModules

public List<Module> loadModules(String filepath)
                         throws FileIsNotAModuleDirectoryException,
IOException

Method call to load the jar files in a folder path. It will call the load method of the module.

Parameters:

filepath - path of the folder file.

Throws:

FileIsNotAModuleDirectoryException - If the target path was not a module directory.

IOException - If the file was not a JarFile.

loadModule

public Module loadModule(Module module)

Load a module already built
It will call the load method of the module.

Parameters:

module - The module you want to load.

loadModule

public Module loadModule(File file)
                  throws IOException

Load a module.

Parameters:

file - The jar file. It should be a module.

Throws:

IOException - If the file was not a JarFile.

loadModule

public Module loadModule(File file,
 URLClassLoader urlClassLoader)
                  throws IOException

Load a module.

Parameters:

file - The jar file. It should be a module.

urlClassLoader - The used classLoader.

Throws:

IOException - If the file was not a JarFile.

startModules

public void startModules()
                  throws MissingDependenciesModuleException

Put and start all loaded modules in the ModuleManager.

Throws:

MissingDependenciesModuleException

startModules

public void startModules(List<Module> modules)
                  throws MissingDependenciesModuleException

Throws:

MissingDependenciesModuleException

startModule

public void startModule(Module module)
                 throws MissingDependenciesModuleException

Throws:

MissingDependenciesModuleException

loadModule

public void loadModule(String filepath)
                throws IOException

Load a module from a jar file path

Parameters:

filepath - jar file path you want to load

Throws:

IOException - If the file was not a JarFile.

isValid

public boolean isValid(JarFile file)

Check if a jar file is in the good format
see ModuleBuilder for details.

Parameters:

file - Jar file you want to check.

Returns:

True if it's valid, false if it isn't.

isValid

public boolean isValid(File file)
                throws IOException

Check if a file is in the good format
see ModuleBuilder for details.

Parameters:

file - File you want to check

Returns:

True if it's valid, false if it isn't

Throws:

IOException - If the file was not a JarFile.

isValid

public boolean isValid(String filepath)
                throws IOException

Check if a jar file is in the good format
see ModuleBuilder for details.

Parameters:

filepath - jar file path you want to check

Returns:

true if it's valid, false if it isn't

Throws:

IOException - If the file was not a JarFile.

getLoadedModules

public List<Module> getLoadedModules()

Get a list of loaded Module.

Returns:

The loaded Module list.

getStartedModule

public List<Module> getStartedModule()

Get a list of started Module.

Returns:

The started Module list.