BaseModuleManager (Modular 1.0 API)

java.lang.Object
- net.mountainblade.modular.impl.BaseModuleManager

All Implemented Interfaces:

Module, ModuleManager

Direct Known Subclasses:

DefaultModuleManager, HierarchicModuleManager
```
public class BaseModuleManager
extends Object
implements ModuleManager
```
Represents the default implementation for module managers.

Version:

1.0

Author:

spaceemotion

Constructor Summary

Constructors
Constructor and Description
`BaseModuleManager(ModuleRegistry registry, org.codehaus.plexus.classworlds.realm.ClassRealm realm)` Creates a new module manager instance.
`BaseModuleManager(ModuleRegistry registry, org.codehaus.plexus.classworlds.realm.ClassRealm parentRealm, ClassLoader classLoader)` Creates a new module manager instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addToLocalClassPath(URL... urls)` Adds the given url(s) as URIs to the local class path.
`static void`	`blacklist(String name)` Blacklists the given directory / file name so folders with the same name will be ignored during the discovery process.
`static void`	`enableThoroughSearch(boolean toggle)` Toggles the state of the "thorough search" mode.
`static URL`	`findClassLoaderRootURL(Class aClass)` Tries to find the root URL from the given class by getting the full URL to the class file itself first, then removing the additional path again.
`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.
`static void`	`include(URI... uris)` Adds the given URIs to the local classpath which will be checked when loading modules.
`static void`	`includeFullClassPath()` Includes all elements in the current java class path as retrieved by the "java.class.path" system property.
`<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 root, 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.
`static org.codehaus.plexus.classworlds.realm.ClassRealm`	`newRealm(org.codehaus.plexus.classworlds.realm.ClassRealm parent, ClassLoader classLoader)` Creates a new class realm.
`<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.
`protected void`	`shutdown(Iterator<Module> iterator)`
`static boolean`	`thoroughSearchEnabled()` Indicates whether or not the "thorough search mode" is enabled.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseModuleManager
```
public BaseModuleManager(ModuleRegistry registry,
                         org.codehaus.plexus.classworlds.realm.ClassRealm parentRealm,
                         ClassLoader classLoader)
```
    Creates a new module manager instance. It is not recommended to
    
    Parameters:
    
    registry - A registry instance
    
    parentRealm - The parent realm, can be left at null
    
    classLoader - A parent class loader, can be left at null
  - BaseModuleManager
```
public BaseModuleManager(ModuleRegistry registry,
                         org.codehaus.plexus.classworlds.realm.ClassRealm realm)
```
    Creates a new module manager instance.
    
    Parameters:
    
    registry - A registry instance
    
    realm - The class realm to load our modules in
- Method Detail
  - getRegistry
```
public final ModuleRegistry getRegistry()
```
    Description copied from interface: ModuleManager
    
    Gets the registry containing all registered (loaded) Modules.
    
    Specified by:
    
    getRegistry in interface ModuleManager
    
    Returns:
    
    The underlying module registry
  - getInjector
```
public final Injector getInjector()
```
    Description copied from interface: ModuleManager
    
    Gets the underlying field injector. Use this if you want to add support for custom field types.
    
    Specified by:
    
    getInjector in interface ModuleManager
    
    Returns:
    
    The injector instance
  - getLoader
```
public final ModuleLoader getLoader()
```
    Description copied from interface: ModuleManager
    
    Gets the used module loader instance. Use this to set the loading strategy for example.
    
    Specified by:
    
    getLoader in interface ModuleManager
    
    Returns:
    
    The underlying module loader
  - provideSimple
```
public <T extends Module> T provideSimple(T module)
```
    Description copied from interface: ModuleManager
    
    Simply provides a module instance and stores it in the registry. This will skip all injection and method calls.
    
    Specified by:
    
    provideSimple in interface ModuleManager
    
    Type Parameters:
    
    T - The module type
    
    Parameters:
    
    module - The module instance
    
    Returns:
    
    The module instance to allow method chaining
    
    See Also:
    
    ModuleManager.provide(Module)
  - provide
```
public <T extends Module> T provide(T module)
```
    Description copied from interface: ModuleManager
    
    Stores the given module instance in the registry, but also executes all injection magic and calls the usual methods.
    
    Specified by:
    
    provide in interface ModuleManager
    
    Type Parameters:
    
    T - The module type
    
    Parameters:
    
    module - The module instance
    
    Returns:
    
    The module instance to allow method chaining
    
    See Also:
    
    ModuleManager.provideSimple(Module)
  - loadModule
```
public <M extends Module> M loadModule(Class<M> moduleClass,
                                       Filter... filters)
```
    Description copied from interface: ModuleManager
    
    Loads only the given module class and its dependencies.
    
    Specified by:
    
    loadModule in interface ModuleManager
    
    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
```
public Collection<Module> loadModules(String resource,
                                      Filter... filters)
```
    Description copied from interface: ModuleManager
    
    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.
    
    Specified by:
    
    loadModules in interface ModuleManager
    
    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.
  - loadModules
```
public Collection<Module> loadModules(File file,
                                      Filter... filters)
```
    Description copied from interface: ModuleManager
    
    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 ModuleManager.loadModules(URI, Filter...).
    
    Specified by:
    
    loadModules in interface ModuleManager
    
    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
```
public Collection<Module> loadModules(URI uri,
                                      Filter... filters)
```
    Description copied from interface: ModuleManager
    
    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.
    
    Specified by:
    
    loadModules in interface ModuleManager
    
    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
```
public Collection<Module> loadModules(URI uri,
                                      String packageName,
                                      Filter... filters)
```
    Description copied from interface: ModuleManager
    
    Loads modules from a URI with support for a resource package filter.
    
    Specified by:
    
    loadModules in interface ModuleManager
    
    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
```
public Collection<Module> loadModules(Collection<URI> uris,
                                      String root,
                                      Filter... filters)
```
    Description copied from interface: ModuleManager
    
    Loads modules from a collection of URIs with support for a resource package filter.
    
    Specified by:
    
    loadModules in interface ModuleManager
    
    Parameters:
    
    uris - A collection of URIs to load the modules from
    
    root - The root package name to look for
    
    filters - An array of filters to use
    
    Returns:
    
    A collection of all successfully loaded modules.
  - 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
    
    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
    
    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
  - shutdown
```
protected void shutdown(Iterator<Module> iterator)
```
  - newRealm
```
public static org.codehaus.plexus.classworlds.realm.ClassRealm newRealm(org.codehaus.plexus.classworlds.realm.ClassRealm parent,
                                                                        ClassLoader classLoader)
```
    Creates a new class realm.
    
    Parameters:
    
    parent - The parent realm, if any - can be left at null
    
    classLoader - The parent class loader, if any - can be left at null
    
    Returns:
    
    A new class realm
    
    Throws:
    
    RuntimeException - When a realm of the same name already exists, as we're using UUIDs this should never happen...
  - blacklist
```
public static void blacklist(String name)
```
    Blacklists the given directory / file name so folders with the same name will be ignored during the discovery process.
    
    Parameters:
    
    name - The name of the directory or file
  - include
```
public static void include(URI... uris)
```
    Adds the given URIs to the local classpath which will be checked when loading modules.
    
    Parameters:
    
    uris - The URIs to add
  - includeFullClassPath
```
public static void includeFullClassPath()
```
    Includes all elements in the current java class path as retrieved by the "java.class.path" system property. This should only be used when the application is using some black magic and changes the class loader on startup. It is also recommended to only use this method without thorough search.
  - enableThoroughSearch
```
public static void enableThoroughSearch(boolean toggle)
```
    Toggles the state of the "thorough search" mode. This mode was an internal first solution to a problem that, when running the application from inside an IDE, some modules might not work as expected because their requirements weren't loaded beforehand. However, this will increase the loading time drastically. This mode can also be enabled by commandline (using the -Dmodular.thoroughSearch property).
    
    Parameters:
    
    toggle - True if the mode should be enabled, false if disabled
  - thoroughSearchEnabled
```
public static boolean thoroughSearchEnabled()
```
    Indicates whether or not the "thorough search mode" is enabled.
    
    Returns:
    
    True if enabled, false if not
    
    See Also:
    
    enableThoroughSearch(boolean)
  - addToLocalClassPath
```
public static void addToLocalClassPath(URL... urls)
```
    Adds the given url(s) as URIs to the local class path. This needs to be done before a manager gets created as each manager holds a modified copy of the static list.
    
    Parameters:
    
    urls - The url(s) to add
  - findClassLoaderRootURL
```
public static URL findClassLoaderRootURL(Class aClass)
```
    Tries to find the root URL from the given class by getting the full URL to the class file itself first, then removing the additional path again.
    
    Parameters:
    
    aClass - The class to get the URL for
    
    Returns:
    
    The class loader's root URL, or null if none could be found

Class BaseModuleManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseModuleManager

BaseModuleManager

Method Detail

getRegistry

getInjector

getLoader

provideSimple

provide

loadModule

loadModules

loadModules

loadModules

loadModules

loadModules

getModule

getInformation

shutdown

shutdown

newRealm

blacklist

include

includeFullClassPath

enableThoroughSearch

thoroughSearchEnabled

addToLocalClassPath

findClassLoaderRootURL