net.mountainblade.modular.impl

Class ModuleRegistry

java.lang.Object

net.mountainblade.modular.impl.Destroyable

net.mountainblade.modular.impl.ModuleRegistry

public class ModuleRegistry
extends Destroyable

Represents a registry for modules. It also stores all additional instances that belong to that module.

Version:

1.0

Author:

spaceemotion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleRegistry.Entry Represents the registry entry DTO.

Method Summary

Modifier and Type	Method and Description
protected void	addGhostModule(Class<? extends Module> moduleClass, Module module, ModuleInformation information) Adds a "ghost" module which has an entry but is not added to the loaded modules list and thus will only be visible to the injector.
protected void	addModule(Class<? extends Module> moduleClass, ModuleRegistry.Entry entry, boolean ghost) Adds a module to the registry.
protected ModuleRegistry.Entry	createEntry(Class<? extends Module> moduleClass, ModuleInformation information) Creates a new registry entry for the given module.
protected void	destroy() Attempts to "destroy" the object by clearing memory (e.g.
protected ModuleRegistry.Entry	getEntry(Class<? extends Module> moduleClass) Gets the registry entry for the given module.
ModuleInformation	getInformation(Class<? extends Module> moduleClass) Gets the module information for the given module.
<M extends Module> M	getModule(Class<M> moduleClass) Gets a module by its class.
Collection<Module>	getModules() Gets a collection of all currently registered modules.
Collection<Module>	getModules(ModuleState state) Gets a collection of all registered modules with the given state.
protected Map<Class<? extends Module>,ModuleRegistry.Entry>	getRegistry() Returns the internal registry.

Methods inherited from class java.lang.Object

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

Method Detail

getModule

public <M extends Module> M getModule(Class<M> moduleClass)

Gets a module by its class. This also can fetch an implementation by its implementing module.

Type Parameters:

M - The module type

Parameters:

moduleClass - The class of the module

Returns:

The instance of the module or null

getInformation

public ModuleInformation getInformation(Class<? extends Module> moduleClass)

Gets the module information for the given module.

Parameters:

moduleClass - The class of the module

Returns:

The module information or null

getModules

public Collection<Module> getModules()

Gets a collection of all currently registered modules.

Returns:

A collection of all modules

getModules

public Collection<Module> getModules(ModuleState state)

Gets a collection of all registered modules with the given state.

Parameters:

state - The state to check against

Returns:

A collection of the filtered modules

addGhostModule

protected void addGhostModule(Class<? extends Module> moduleClass,
                              Module module,
                              ModuleInformation information)

Adds a "ghost" module which has an entry but is not added to the loaded modules list and thus will only be visible to the injector.

Parameters:

moduleClass - The class of the module we're implementing

module - The implementation

information - The information instance

addModule

protected void addModule(Class<? extends Module> moduleClass,
                         ModuleRegistry.Entry entry,
                         boolean ghost)

Adds a module to the registry.

Parameters:

moduleClass - The class of the module we're implementing

entry - The registry entry

ghost - False if it should be added to collection, true if it should be hidden

createEntry

protected ModuleRegistry.Entry createEntry(Class<? extends Module> moduleClass,
                                           ModuleInformation information)

Creates a new registry entry for the given module. Please keep in mind that this will already add the entry to the registry.

Parameters:

moduleClass - The class of the module we're implementing

information - The module's information

Returns:

A new registry entry

getEntry

protected ModuleRegistry.Entry getEntry(Class<? extends Module> moduleClass)

Gets the registry entry for the given module.

Parameters:

moduleClass - The class of the module we're implementing

Returns:

An 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

getRegistry

protected Map<Class<? extends Module>,ModuleRegistry.Entry> getRegistry()

Returns the internal registry.

Returns:

An unmodifiable map representing the registry