io.github.bananapuncher714.cartographer.core.module

Class ModuleLoader

java.lang.Object

io.github.bananapuncher714.cartographer.core.module.ModuleLoader

public class ModuleLoader
extends java.lang.Object

Load modules and their descriptions, like a plugin.

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
ModuleLoader(ModuleManager manager, Cartographer plugin)

Method Summary

Modifier and Type	Method and Description
void	disable(Module module) Disable the module and remove whatever it may be trying to do.
ModuleClassLoader	getClassLoaderFor(Module module) Get the ModuleClassLoader for the given module.
ModuleDescription	getDescriptionFor(java.io.File file) Get a ModuleDescription from a module jar.
ModuleDescription	getDescriptionFor(java.io.File file, java.io.InputStream stream) Get a ModuleDescription from an input stream.
Module	load(ModuleDescription description) Load a module with the given description.
boolean	unload(Module module) Unload the given module and all their classes, does not guarantee that the module's classes are not be in use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleLoader

public ModuleLoader(ModuleManager manager,
                    Cartographer plugin)

Method Detail

load

public Module load(ModuleDescription description)

Load a module with the given description.

Parameters:

description - A ModuleDescription of the module being loaded. Cannot be null.

Returns:

A new module if successful.

unload

public boolean unload(Module module)

Unload the given module and all their classes, does not guarantee that the module's classes are not be in use.

Parameters:

module - The module to unload. Cannot be null.

Returns:

Whether or not this module was unloaded.

disable

public void disable(Module module)

Disable the module and remove whatever it may be trying to do.

Parameters:

module -

getClassLoaderFor

public ModuleClassLoader getClassLoaderFor(Module module)

Get the ModuleClassLoader for the given module.

Parameters:

module - Cannot be null.

Returns:

Null if the module isn't loaded by Cartographer2.

getDescriptionFor

public ModuleDescription getDescriptionFor(java.io.File file)

Get a ModuleDescription from a module jar.

Parameters:

file - The module jar. Cannot be null.

Returns:

A ModuleDescription if successful.

getDescriptionFor

public ModuleDescription getDescriptionFor(java.io.File file,
                                           java.io.InputStream stream)

Get a ModuleDescription from an input stream.

Parameters:

file - The file of the module, cannot be null.

stream - The stream to read from. Cannot be null.

Returns:

A ModuleDescription generated from the stream.