A B C D E F G H I L M N O P R S T V W

A

addGhostModule(Class<? extends Module>, Module, ModuleInformation) - Method in class net.mountainblade.modular.impl.ModuleRegistry

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.

addModule(Class<? extends Module>, ModuleRegistry.Entry, boolean) - Method in class net.mountainblade.modular.impl.ModuleRegistry

Adds a module to the registry.

addNode(E) - Method in class net.mountainblade.modular.impl.TopologicalSortedList

Adds a node to the list.

addToLocalClassPath(URL...) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Adds the given url(s) as URIs to the local class path.

AnnotationPresent - Class in net.mountainblade.modular.filters

Represents a filter that only lets implementations with a specific annotation pass through.

AnnotationPresent(Class<? extends Annotation>) - Constructor for class net.mountainblade.modular.filters.AnnotationPresent

Creates a new annotation filter.

Annotations - Class in net.mountainblade.modular.impl

Represents a helper for Annotations.

B

BaseModuleManager - Class in net.mountainblade.modular.impl

Represents the default implementation for module managers.

BaseModuleManager(ModuleRegistry, ClassRealm, ClassLoader) - Constructor for class net.mountainblade.modular.impl.BaseModuleManager

Creates a new module manager instance.

BaseModuleManager(ModuleRegistry, ClassRealm) - Constructor for class net.mountainblade.modular.impl.BaseModuleManager

Creates a new module manager instance.

blacklist(String) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Blacklists the given directory / file name so folders with the same name will be ignored during the discovery process.

C

call(Object, Class<? extends Annotation>, int, Class<?>[], Object...) - Static method in class net.mountainblade.modular.impl.Annotations

Calls a method with a specific annotation and parameters.

compareTo(Version) - Method in class net.mountainblade.modular.Version

construct(Inject, Class<? extends T>, Module) - Method in interface net.mountainblade.modular.impl.Injector.Constructor

Constructs (or provides) an instance of the set type.

createEntry(Class<? extends Module>, ModuleInformation) - Method in class net.mountainblade.modular.impl.ModuleRegistry

Creates a new registry entry for the given module.

Current() - Constructor for class net.mountainblade.modular.annotations.Inject.Current

CycleException(String) - Constructor for exception net.mountainblade.modular.impl.TopologicalSortedList.CycleException

D

Default() - Constructor for class net.mountainblade.modular.annotations.Implementation.Default

DefaultModuleManager - Class in net.mountainblade.modular.impl

Represents the default implementation of a ModuleManager.

DefaultModuleManager() - Constructor for class net.mountainblade.modular.impl.DefaultModuleManager

Creates a new module manager instance.

DefaultModuleManager(ClassLoader) - Constructor for class net.mountainblade.modular.impl.DefaultModuleManager

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

destroy() - Method in class net.mountainblade.modular.impl.Destroyable

Attempts to "destroy" the object by clearing memory (e.g.

destroy() - Method in class net.mountainblade.modular.impl.Injector

destroy() - Method in class net.mountainblade.modular.impl.ModuleLoader

destroy() - Method in class net.mountainblade.modular.impl.ModuleRegistry

Destroyable - Class in net.mountainblade.modular.impl

Represents a destroyable object.

Destroyable() - Constructor for class net.mountainblade.modular.impl.Destroyable

E

Edge(TopologicalSortedList.Node<E>, TopologicalSortedList.Node<E>) - Constructor for class net.mountainblade.modular.impl.TopologicalSortedList.Edge

enableThoroughSearch(boolean) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Toggles the state of the "thorough search" mode.

equals(Object) - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

equals(Object) - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

equals(Object) - Method in class net.mountainblade.modular.Version

exactly() - Method in class net.mountainblade.modular.impl.Injector.Builder

Marks this configuration to restrict the field type to be exactly the given one.

F

Filter - Interface in net.mountainblade.modular

Represents a module filter.

findClassLoaderRootURL(Class) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

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.

G

getAnnotation() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

Gets the implementation annotation.

getAuthors() - Method in interface net.mountainblade.modular.ModuleInformation

Gets the author(s) of the module.

getBuild() - Method in class net.mountainblade.modular.Version

Gets the build label extension.

getClassEntry(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.ModuleLoader

Fetches the class entry for the given module implementation class.

getDependencies() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

Gets a collection of all module dependencies as injector entries.

getEntry(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.ModuleRegistry

Gets the registry entry for the given module.

getImplementation() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

Gets the actual implementation class.

getInformation(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.BaseModuleManager

getInformation(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.HierarchicModuleManager

getInformation() - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

Gets the module's information.

getInformation(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.ModuleRegistry

Gets the module information for the given module.

getInformation(Class<? extends Module>) - Method in interface net.mountainblade.modular.ModuleManager

Gets information about a specific module.

getInjector() - Method in class net.mountainblade.modular.impl.BaseModuleManager

getInjector() - Method in interface net.mountainblade.modular.ModuleManager

Gets the underlying field injector.

getLoader() - Method in class net.mountainblade.modular.impl.BaseModuleManager

getLoader() - Method in interface net.mountainblade.modular.ModuleManager

Gets the used module loader instance.

getMajor() - Method in class net.mountainblade.modular.Version

Gets the major version label representing incompatible API changes.

getMinor() - Method in class net.mountainblade.modular.Version

Gets the minor version label for functionality in a backwards-compatible manner.

getModule(Class<M>) - Method in class net.mountainblade.modular.impl.BaseModuleManager

getModule(Class<M>) - Method in class net.mountainblade.modular.impl.HierarchicModuleManager

getModule() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

Gets the module we are implementing.

getModule() - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

Returns the module implementation instance.

getModule(Class<M>) - Method in class net.mountainblade.modular.impl.ModuleRegistry

Gets a module by its class.

getModule(Class<M>) - Method in interface net.mountainblade.modular.ModuleManager

Gets a specific module by its class.

getModuleClass() - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

Returns the class of the module we're implementing.

getModules() - Method in class net.mountainblade.modular.impl.ModuleRegistry

Gets a collection of all currently registered modules.

getModules(ModuleState) - Method in class net.mountainblade.modular.impl.ModuleRegistry

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

getPatch() - Method in class net.mountainblade.modular.Version

Gets the patch label representing backwards-compatible bug fixes.

getPreRelease() - Method in class net.mountainblade.modular.Version

Gets the pre-release label extension.

getProperties() - Method in interface net.mountainblade.modular.ModuleInformation

Gets custom module properties.

getRealm() - Method in class net.mountainblade.modular.impl.ModuleLoader

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

getRegistry() - Method in class net.mountainblade.modular.impl.BaseModuleManager

getRegistry() - Method in class net.mountainblade.modular.impl.ModuleRegistry

Returns the internal registry.

getRegistry() - Method in interface net.mountainblade.modular.ModuleManager

Gets the registry containing all registered (loaded) Modules.

getRequirements() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

Gets a collection of all required modules.

getState() - Method in interface net.mountainblade.modular.ModuleInformation

Gets the current state of the module.

getValue() - Method in class net.mountainblade.modular.impl.TopologicalSortedList.Node

getVersion() - Method in interface net.mountainblade.modular.ModuleInformation

Gets the module version.

H

hashCode() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

hashCode() - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

hashCode() - Method in class net.mountainblade.modular.Version

HierarchicModuleManager - Class in net.mountainblade.modular.impl

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

HierarchicModuleManager(BaseModuleManager) - Constructor for class net.mountainblade.modular.impl.HierarchicModuleManager

Creates a new hierarchic module manager instance.

HierarchicModuleManager(BaseModuleManager, ClassLoader) - Constructor for class net.mountainblade.modular.impl.HierarchicModuleManager

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

I

ignoreModuleClass(Class<? extends Module>) - Method in class net.mountainblade.modular.impl.ModuleLoader

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

Implementation - Annotation Type in net.mountainblade.modular.annotations

Represents an annotation that is used to mark implementation of modules.

Implementation.Default - Class in net.mountainblade.modular.annotations

Default implementation representing that an implementation should use its default implementation (current class).

include(URI...) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Adds the given URIs to the local classpath which will be checked when loading modules.

includeFullClassPath() - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Includes all elements in the current java class path as retrieved by the "java.class.path" system property.

Initialize - Annotation Type in net.mountainblade.modular.annotations

Represents an annotation that marks method(s) that should be executed when a module gets loaded.

Inject - Annotation Type in net.mountainblade.modular.annotations

Represents an annotation that, if attached, automatically fills fields with their dependencies when a module gets loaded.

inject(Class<T>) - Method in class net.mountainblade.modular.impl.Injector

Creates a new injection builder to set up a new field injection configuration.

inject(ModuleRegistry.Entry) - Method in class net.mountainblade.modular.impl.Injector

Injects the given module registry entry with its dependencies.

inject(Module) - Method in class net.mountainblade.modular.impl.Injector

Injects the given module instance with its dependencies.

Inject.Current - Class in net.mountainblade.modular.annotations

Default implementation representing that an injection should use the current model instance.

injectAndInitialize(ModuleManager, Module, ModuleInformationImpl) - Method in class net.mountainblade.modular.impl.ModuleLoader

Injects and initializes the given module.

InjectFailedException - Exception in net.mountainblade.modular.impl

Represents an exception that gets thrown when an injection failed.

InjectFailedException(String) - Constructor for exception net.mountainblade.modular.impl.InjectFailedException

InjectFailedException(String, Throwable) - Constructor for exception net.mountainblade.modular.impl.InjectFailedException

Injector - Class in net.mountainblade.modular.impl

Represents a dependency Injector for various kinds of dependencies (only affects fields).

Injector.Builder<T> - Class in net.mountainblade.modular.impl

Represents an injection builder.

Injector.Constructor<T> - Interface in net.mountainblade.modular.impl

Represents an instance constructor.

inside(URL) - Static method in class net.mountainblade.modular.PathHelper

Returns an URI representing the parent directory of the given URL.

inside(String) - Static method in class net.mountainblade.modular.PathHelper

Returns an URI representing the parent directory of the given path.

InstanceOf - Class in net.mountainblade.modular.filters

Represents a filter that only lets implementations of the given parent class pass through.

InstanceOf(Class) - Constructor for class net.mountainblade.modular.filters.InstanceOf

Creates a new "instanceof" filter.

isRequiredBefore(TopologicalSortedList.Node<E>) - Method in class net.mountainblade.modular.impl.TopologicalSortedList.Node

Marks this node as a requirement for the given node.

isRequiredBefore(E) - Method in class net.mountainblade.modular.impl.TopologicalSortedList.Node

Marks this node as a requirement for the given element.

isSnapshot() - Method in class net.mountainblade.modular.Version

Indicates whether or not the version represents a snapshot version (indicated by the "SNAPSHOT" suffix in the pre-release label).

L

loadModule(Class<M>, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModule(ModuleManager, ModuleLoader.ClassEntry) - Method in class net.mountainblade.modular.impl.ModuleLoader

Loads a module using its pre-compiled class entry.

loadModule(Class<M>, Filter...) - Method in interface net.mountainblade.modular.ModuleManager

Loads only the given module class and its dependencies.

loadModules(String, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModules(File, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModules(URI, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModules(URI, String, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModules(Collection<URI>, String, Filter...) - Method in class net.mountainblade.modular.impl.BaseModuleManager

loadModules(URI, Filter...) - Method in interface net.mountainblade.modular.ModuleManager

Load modules from a URI.

loadModules(URI, String, Filter...) - Method in interface net.mountainblade.modular.ModuleManager

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

loadModules(File, Filter...) - Method in interface net.mountainblade.modular.ModuleManager

Loads modules from the given file.

loadModules(String, Filter...) - Method in interface net.mountainblade.modular.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.

loadModules(Collection<URI>, String, Filter...) - Method in interface net.mountainblade.modular.ModuleManager

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

M

marked(Annotation) - Method in class net.mountainblade.modular.impl.Injector.Builder

Adds the given annotation instance to the required annotations.

marked(Class<? extends Annotation>) - Method in class net.mountainblade.modular.impl.Injector.Builder

Adds the given annotation type to the required annotations.

Module - Interface in net.mountainblade.modular

Represents a base for modules.

ModuleInformation - Interface in net.mountainblade.modular

Represents a holder for meta data and other information about a module.

ModuleLoader - Class in net.mountainblade.modular.impl

Represents a loader for modules.

ModuleLoader(ClassRealm, ModuleRegistry, Injector) - Constructor for class net.mountainblade.modular.impl.ModuleLoader

Creates a new module loader.

ModuleLoader.ClassEntry - Class in net.mountainblade.modular.impl

Represents a class entry (DTO).

ModuleManager - Interface in net.mountainblade.modular

Represents a module manager.

ModuleRegistry - Class in net.mountainblade.modular.impl

Represents a registry for modules.

ModuleRegistry.Entry - Class in net.mountainblade.modular.impl

Represents the registry entry DTO.

ModuleState - Enum in net.mountainblade.modular

Represents the state a module can be currently in.

N

near(Class) - Static method in class net.mountainblade.modular.PathHelper

Returns the package name ready to be used when trying to load modules from the same package (and below) as the given class.

net.mountainblade.modular - package net.mountainblade.modular

net.mountainblade.modular.annotations - package net.mountainblade.modular.annotations

net.mountainblade.modular.filters - package net.mountainblade.modular.filters

net.mountainblade.modular.impl - package net.mountainblade.modular.impl

newRealm(ClassRealm, ClassLoader) - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Creates a new class realm.

Node(E) - Constructor for class net.mountainblade.modular.impl.TopologicalSortedList.Node

Not - Class in net.mountainblade.modular.filters

Represents a filter that negates the output of another.

Not(Filter) - Constructor for class net.mountainblade.modular.filters.Not

Creates a new "not" filter which inverts the output of the given filter.

nullable() - Method in class net.mountainblade.modular.impl.Injector.Builder

Marks this configuration as "nullable".

O

Or - Class in net.mountainblade.modular.filters

Represents a filter which returns true if one of the filters returns true as well.

Or(Filter...) - Constructor for class net.mountainblade.modular.filters.Or

Creates a new "or" filter which returns true if one of the filters returns true as well.

P

parse(String) - Static method in class net.mountainblade.modular.Version

Parses the given string and tries to return only one version instance.

parseMulti(String...) - Static method in class net.mountainblade.modular.Version

Tries to find as many version tags within the given text and returns the result as an array.

PathHelper - Class in net.mountainblade.modular

Represents a helper class to assist with loading modules from various locations.

provide(T) - Method in class net.mountainblade.modular.impl.BaseModuleManager

provide(T) - Method in interface net.mountainblade.modular.ModuleManager

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

provideSimple(T) - Method in class net.mountainblade.modular.impl.BaseModuleManager

provideSimple(T) - Method in interface net.mountainblade.modular.ModuleManager

Simply provides a module instance and stores it in the registry.

R

registerEntry(ModuleLoader.ClassEntry, Module, ModuleInformationImpl, ModuleRegistry.Entry) - Method in class net.mountainblade.modular.impl.ModuleLoader

Registers a new class entry in the system.

Requires - Annotation Type in net.mountainblade.modular.annotations

Represents an annotation that tells modular that we require the given module even though it might not have been loading automatically (through the load functions).

retain(ModuleLoader.ClassEntry) - Method in interface net.mountainblade.modular.Filter

Determines whether or not the given candidate should be retained in the loading process.

retain(ModuleLoader.ClassEntry) - Method in class net.mountainblade.modular.filters.AnnotationPresent

retain(ModuleLoader.ClassEntry) - Method in class net.mountainblade.modular.filters.InstanceOf

retain(ModuleLoader.ClassEntry) - Method in class net.mountainblade.modular.filters.Not

retain(ModuleLoader.ClassEntry) - Method in class net.mountainblade.modular.filters.Or

S

SEMVER_DETECT - Static variable in class net.mountainblade.modular.Version

SEMVER_FORMAT - Static variable in class net.mountainblade.modular.Version

setLoadingStrategy(Class<? extends Strategy>) - Method in class net.mountainblade.modular.impl.ModuleLoader

Sets the loading strategy on the class realm.

setLoadingStrategy(Strategy) - Method in class net.mountainblade.modular.impl.ModuleLoader

Sets the loading strategy on the class realm.

Shutdown - Annotation Type in net.mountainblade.modular.annotations

Represents an annotation that marks method(s) that should be executed when a module gets shut down by the manager.

shutdown() - Method in class net.mountainblade.modular.impl.BaseModuleManager

shutdown(Iterator<Module>) - Method in class net.mountainblade.modular.impl.BaseModuleManager

shutdown() - Method in class net.mountainblade.modular.impl.HierarchicModuleManager

shutdown(boolean) - Method in class net.mountainblade.modular.impl.HierarchicModuleManager

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

shutdown() - Method in interface net.mountainblade.modular.ModuleManager

Tells the manager to shut down and destroy all loaded modules.

SNAPSHOT - Static variable in class net.mountainblade.modular.Version

sort() - Method in class net.mountainblade.modular.impl.TopologicalSortedList

Sorts the list in topological order.

T

thoroughSearchEnabled() - Static method in class net.mountainblade.modular.impl.BaseModuleManager

Indicates whether or not the "thorough search mode" is enabled.

TopologicalSortedList<E> - Class in net.mountainblade.modular.impl

Represents a topological sorted list.

TopologicalSortedList() - Constructor for class net.mountainblade.modular.impl.TopologicalSortedList

TopologicalSortedList.CycleException - Exception in net.mountainblade.modular.impl

TopologicalSortedList.Edge<E> - Class in net.mountainblade.modular.impl

TopologicalSortedList.Node<E> - Class in net.mountainblade.modular.impl

Represents a node in a topological sorted list.

toString() - Method in class net.mountainblade.modular.impl.ModuleLoader.ClassEntry

toString() - Method in class net.mountainblade.modular.impl.ModuleRegistry.Entry

toString() - Method in class net.mountainblade.modular.impl.TopologicalSortedList.Node

toString() - Method in class net.mountainblade.modular.Version

Converts this version to a usable version tag.

V

valueOf(String) - Static method in enum net.mountainblade.modular.ModuleState

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.mountainblade.modular.ModuleState

Returns an array containing the constants of this enum type, in the order they are declared.

Version - Class in net.mountainblade.modular

Represents a class that parses and stores version information using the extended semantic version format (with pre-release and build labels).

Version(int) - Constructor for class net.mountainblade.modular.Version

Creates a new version.

Version(int, int) - Constructor for class net.mountainblade.modular.Version

Creates a new version.

Version(int, int, int) - Constructor for class net.mountainblade.modular.Version

Creates a new version.

Version(int, int, int, boolean) - Constructor for class net.mountainblade.modular.Version

Creates a new version.

Version(int, int, int, String, String) - Constructor for class net.mountainblade.modular.Version

Creates a new version.

Version(String) - Constructor for class net.mountainblade.modular.Version

Creates a new version from the given text.

W

with(T) - Method in class net.mountainblade.modular.impl.Injector.Builder

Sets the injected instance to always be the given one.

with(Injector.Constructor<? extends T>) - Method in class net.mountainblade.modular.impl.Injector.Builder

Sets the constructor to the given instance and adds this builder to the registry.

A B C D E F G H I L M N O P R S T V W