net.mountainblade.modular.impl

Class ModuleLoader

java.lang.Object

net.mountainblade.modular.impl.Destroyable

net.mountainblade.modular.impl.ModuleLoader

public final class ModuleLoader
extends Destroyable

Represents a loader for modules.

Version:

1.0

Author:

spaceemotion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleLoader.ClassEntry Represents a class entry (DTO).

Constructor Summary

Constructors

Constructor and Description
ModuleLoader(org.codehaus.plexus.classworlds.realm.ClassRealm realm, ModuleRegistry registry, Injector injector) Creates a new module loader.

Method Summary

Modifier and Type	Method and Description
protected void	destroy() Attempts to "destroy" the object by clearing memory (e.g.
ModuleLoader.ClassEntry	getClassEntry(Class<? extends Module> implClass) Fetches the class entry for the given module implementation class.
org.codehaus.plexus.classworlds.realm.ClassRealm	getRealm() Returns the underlying class realm that gets used when loading classes.
boolean	ignoreModuleClass(Class<? extends Module> ignore) Adds the given class to the list of ignored module superclasses / -interfaces.
void	injectAndInitialize(ModuleManager manager, Module module, net.mountainblade.modular.impl.ModuleInformationImpl information) Injects and initializes the given module.
Module	loadModule(ModuleManager moduleManager, ModuleLoader.ClassEntry classEntry) Loads a module using its pre-compiled class entry.
void	registerEntry(ModuleLoader.ClassEntry classEntry, Module module, net.mountainblade.modular.impl.ModuleInformationImpl information, ModuleRegistry.Entry moduleEntry) Registers a new class entry in the system.
void	setLoadingStrategy(Class<? extends org.codehaus.plexus.classworlds.strategy.Strategy> strategyClass) Sets the loading strategy on the class realm.
void	setLoadingStrategy(org.codehaus.plexus.classworlds.strategy.Strategy strategy) Sets the loading strategy on the class realm.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleLoader

public ModuleLoader(org.codehaus.plexus.classworlds.realm.ClassRealm realm,
                    ModuleRegistry registry,
                    Injector injector)

Creates a new module loader.

Parameters:

realm - The realm we load the modules in, this requires their URLs to be added beforehand

registry - The module registry to register the modules with

injector - The injector to inject their fields with

Method Detail

getRealm

public org.codehaus.plexus.classworlds.realm.ClassRealm getRealm()

Returns the underlying class realm that gets used when loading classes.

Returns:

The class realm instance

setLoadingStrategy

public void setLoadingStrategy(Class<? extends org.codehaus.plexus.classworlds.strategy.Strategy> strategyClass)

Sets the loading strategy on the class realm.

Parameters:

strategyClass - The class of the loading strategy to use

setLoadingStrategy

public void setLoadingStrategy(org.codehaus.plexus.classworlds.strategy.Strategy strategy)

Sets the loading strategy on the class realm.

Parameters:

strategy - The loading strategy to use

ignoreModuleClass

public boolean ignoreModuleClass(Class<? extends Module> ignore)

Adds the given class to the list of ignored module superclasses / -interfaces.

Parameters:

ignore - The module super-class to ignore during the loading process

Returns:

True if the class could be added, false if not

loadModule

public Module loadModule(ModuleManager moduleManager,
                         ModuleLoader.ClassEntry classEntry)

Loads a module using its pre-compiled class entry.

Parameters:

moduleManager - The module manager to use

classEntry - The class entry to create the module out of

Returns:

A module instance or null if it could not be loaded properly

injectAndInitialize

public void injectAndInitialize(ModuleManager manager,
                                Module module,
                                net.mountainblade.modular.impl.ModuleInformationImpl information)

Injects and initializes the given module.

Parameters:

manager - The module manager to use

module - The module in context

information - The module's information instance

registerEntry

public void registerEntry(ModuleLoader.ClassEntry classEntry,
                          Module module,
                          net.mountainblade.modular.impl.ModuleInformationImpl information,
                          ModuleRegistry.Entry moduleEntry)

Registers a new class entry in the system.

Parameters:

classEntry - The class entry to register

module - The module in context

information - The module's information instance

moduleEntry - The registry entry

getClassEntry

public ModuleLoader.ClassEntry getClassEntry(Class<? extends Module> implClass)

Fetches the class entry for the given module implementation class. If no class entry previously existed this will create the entry. If the given class is either null, is not a module or has been marked as invalid this will return null.

Parameters:

implClass - The class of the module

Returns:

The class entry or null

destroy

protected void destroy()

Description copied from class: Destroyable

Attempts to "destroy" the object by clearing memory (e.g. empty out lists and maps).

Specified by:

destroy in class Destroyable