Package com.chillycheesy.modulo.modules

Class ModuleBuilder

java.lang.Object

com.chillycheesy.modulo.modules.ModuleBuilder

public class ModuleBuilder
extends Object

Class used to build a Module from a File
The file you want to build should be a jar file with a module.yml at the root of the jar.

 name: <name of your module>
 version: <version of your module>
 authors: [<the persons that works on your module>]
 dependencies: [<modules you need to load your module>]
 soft-dependencies: [<modules you can work with without needing it>]
 main: <the path to you module class> for exemple: (com.dev.module.MyAwesomeModule)
 

Method Summary

Modifier and Type	Method	Description
static Module	build(File file)	Method you need to call to build a Module.
static Module	build(File file, URLClassLoader urlClassLoader)	Method you need to call to build a Module
static ModuleConfig	readYml(File file)	Reads the yml file in the root of the jar passed in parameter
static ModuleConfig	readYml(File file, InputStream inputStream)	Reads the yml file in the root of the jar passed in parameter

Methods inherited from class java.lang.Object

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

Method Details

build

public static Module build(File file,
 URLClassLoader urlClassLoader)

Method you need to call to build a Module

Parameters:

file - file you want to build

urlClassLoader - the URLClassLoader you want to use to load the jar modules

Returns:

the built module

build

public static Module build(File file)

Method you need to call to build a Module. It will use the default URLClassLoader to load the jar modules, which is the FactoryURLClassLoader

Parameters:

file - file you want to build

Returns:

the built module

readYml

public static ModuleConfig readYml(File file)
                            throws IOException,
InvalidModuleConfigurationException

Reads the yml file in the root of the jar passed in parameter

Parameters:

file - the jar file of your Module

Returns:

a ModuleConfig

Throws:

IOException - if the file can't be access or read

InvalidModuleConfigurationException - if the configuration doesn't match the rules described on top of the class

readYml

public static ModuleConfig readYml(File file,
 InputStream inputStream)
                            throws IOException,
InvalidModuleConfigurationException

Reads the yml file in the root of the jar passed in parameter

Parameters:

file - the jar file of your Module

inputStream - the InputStream you especially want to use

Returns:

a ModuleConfig

Throws:

IOException - if the file can't be access or read.

InvalidModuleConfigurationException - if the configuration doesn't match the rules described on top of the class.