net.mountainblade.modular.impl

Class HierarchicModuleManager

java.lang.Object

net.mountainblade.modular.impl.BaseModuleManager

net.mountainblade.modular.impl.HierarchicModuleManager

All Implemented Interfaces:

Module, ModuleManager

public class HierarchicModuleManager
extends BaseModuleManager

Represents a hierarchical ModuleManager that inherits the modules from its parent, but allows scoped sub-modules.

Version:

1.0

Author:

spaceemotion

Constructor Summary

Constructors

Constructor and Description
HierarchicModuleManager(BaseModuleManager parent) Creates a new hierarchic module manager instance.
HierarchicModuleManager(BaseModuleManager parent, ClassLoader loader) Creates a new hierarchic module manager instance with a custom parent class loader.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<ModuleInformation>	getInformation(Class<? extends Module> module) Gets information about a specific module.
<M extends Module> com.google.common.base.Optional<M>	getModule(Class<M> module) Gets a specific module by its class.
void	shutdown() Tells the manager to shut down and destroy all loaded modules.
void	shutdown(boolean withParent) Shuts down this module manager with the option to only shut down itself or with the parent.

Methods inherited from class net.mountainblade.modular.impl.BaseModuleManager

addToLocalClassPath, blacklist, enableThoroughSearch, findClassLoaderRootURL, getInjector, getLoader, getRegistry, include, includeFullClassPath, loadModule, loadModules, loadModules, loadModules, loadModules, loadModules, newRealm, provide, provideSimple, shutdown, thoroughSearchEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicModuleManager

public HierarchicModuleManager(BaseModuleManager parent)

Creates a new hierarchic module manager instance. This will initialize a new manager while keeping access to the given parent. The new manager will have a custom registry and loader and be contained inside a its own class realm, but will be able to fetch modules from its parent.

Parameters:

parent - The parent manager to use as a reference

See Also:

DefaultModuleManager

HierarchicModuleManager

public HierarchicModuleManager(BaseModuleManager parent,
                               ClassLoader loader)

Creates a new hierarchic module manager instance with a custom parent class loader.

Parameters:

parent - The parent manager to use as a reference

loader - The custom class loader

See Also:

HierarchicModuleManager(BaseModuleManager)

Method Detail

getModule

public <M extends Module> com.google.common.base.Optional<M> getModule(Class<M> module)

Description copied from interface: ModuleManager

Gets a specific module by its class.

Specified by:

getModule in interface ModuleManager

Overrides:

getModule in class BaseModuleManager

Type Parameters:

M - The module type

Parameters:

module - The module class

Returns:

An optional for the module instance

getInformation

public com.google.common.base.Optional<ModuleInformation> getInformation(Class<? extends Module> module)

Description copied from interface: ModuleManager

Gets information about a specific module.

Specified by:

getInformation in interface ModuleManager

Overrides:

getInformation in class BaseModuleManager

Parameters:

module - The module class

Returns:

An optional for the information

shutdown

public void shutdown()

Description copied from interface: ModuleManager

Tells the manager to shut down and destroy all loaded modules. This can be useful for cases in which you want to have a clear, fresh start.

Specified by:

shutdown in interface ModuleManager

Overrides:

shutdown in class BaseModuleManager

shutdown

public void shutdown(boolean withParent)

Shuts down this module manager with the option to only shut down itself or with the parent.

Parameters:

withParent - True if the parent should also be shut down, false if not