net.mountainblade.modular

Interface ModuleManager

All Superinterfaces:

Module

All Known Implementing Classes:

BaseModuleManager, DefaultModuleManager, HierarchicModuleManager

public interface ModuleManager
extends Module

Represents a module manager.

Version:

1.0

Author:

spaceemotion

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.
Injector	getInjector() Gets the underlying field injector.
ModuleLoader	getLoader() Gets the used module loader instance.
<M extends Module> com.google.common.base.Optional<M>	getModule(Class<M> module) Gets a specific module by its class.
ModuleRegistry	getRegistry() Gets the registry containing all registered (loaded) Modules.
<M extends Module> M	loadModule(Class<M> moduleClass, Filter... filters) Loads only the given module class and its dependencies.
Collection<Module>	loadModules(Collection<URI> uris, String packageName, Filter... filters) Loads modules from a collection of URIs with support for a resource package filter.
Collection<Module>	loadModules(File file, Filter... filters) Loads modules from the given file.
Collection<Module>	loadModules(String resource, Filter... filters) Loads modules inside the current class path with the given string representing either a class file directly or a package and thus functioning as a filter.
Collection<Module>	loadModules(URI uri, Filter... filters) Load modules from a URI.
Collection<Module>	loadModules(URI uri, String packageName, Filter... filters) Loads modules from a URI with support for a resource package filter.
<T extends Module> T	provide(T module) Stores the given module instance in the registry, but also executes all injection magic and calls the usual methods.
<T extends Module> T	provideSimple(T module) Simply provides a module instance and stores it in the registry.
void	shutdown() Tells the manager to shut down and destroy all loaded modules.

Method Detail

provideSimple

<T extends Module> T provideSimple(T module)

Simply provides a module instance and stores it in the registry. This will skip all injection and method calls.

Type Parameters:

T - The module type

Parameters:

module - The module instance

Returns:

The module instance to allow method chaining

See Also:

provide(Module)

provide

<T extends Module> T provide(T module)

Stores the given module instance in the registry, but also executes all injection magic and calls the usual methods.

Type Parameters:

T - The module type

Parameters:

module - The module instance

Returns:

The module instance to allow method chaining

See Also:

provideSimple(Module)

loadModules

Collection<Module> loadModules(URI uri,
                               Filter... filters)

Load modules from a URI. This will load all JAR files (and their containing modules) within the URI as well as any ".class" files assuming the given URI is their root package.

Parameters:

uri - The URI to load the modules from

filters - An array of filters to use

Returns:

A collection of all successfully loaded modules.

loadModules

Collection<Module> loadModules(URI uri,
                               String packageName,
                               Filter... filters)

Loads modules from a URI with support for a resource package filter.

Parameters:

uri - The URI to load the modules from

packageName - The root package name to look for

filters - An array of filters to use

Returns:

A collection of all successfully loaded modules.

loadModules

Collection<Module> loadModules(File file,
                               Filter... filters)

Loads modules from the given file. If the file is a JAR file directly it will only load that JAR, otherwise this will work the same as loadModules(URI, Filter...).

Parameters:

file - The file to load the modules from

filters - An array of filters to use

Returns:

A collection of all successfully loaded modules.

loadModules

Collection<Module> loadModules(String resource,
                               Filter... filters)

Loads modules inside the current class path with the given string representing either a class file directly or a package and thus functioning as a filter.

Parameters:

resource - The resource string, can be the fully qualified class name or a package name

filters - An array of filters to use

Returns:

A collection of all successfully loaded modules.

loadModule

<M extends Module> M loadModule(Class<M> moduleClass,
                                Filter... filters)

Loads only the given module class and its dependencies.

Type Parameters:

M - The module type

Parameters:

moduleClass - The class of the module to load

filters - An array of filters to use

Returns:

Only the given module object to allow for builder-like method chaining

loadModules

Collection<Module> loadModules(Collection<URI> uris,
                               String packageName,
                               Filter... filters)

Loads modules from a collection of URIs with support for a resource package filter.

Parameters:

uris - A collection of URIs to load the modules from

packageName - The root package name to look for

filters - An array of filters to use

Returns:

A collection of all successfully loaded modules.

getModule

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

Gets a specific module by its class.

Type Parameters:

M - The module type

Parameters:

module - The module class

Returns:

An optional for the module instance

getInformation

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

Gets information about a specific module.

Parameters:

module - The module class

Returns:

An optional for the information

getRegistry

ModuleRegistry getRegistry()

Gets the registry containing all registered (loaded) Modules.

Returns:

The underlying module registry

getInjector

Injector getInjector()

Gets the underlying field injector. Use this if you want to add support for custom field types.

Returns:

The injector instance

getLoader

ModuleLoader getLoader()

Gets the used module loader instance. Use this to set the loading strategy for example.

Returns:

The underlying module loader

shutdown

void shutdown()

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.