Interface ModuleWrapper

All Superinterfaces:

InjectionLayerHolder<dev.derklaro.aerogel.Injector>

public interface ModuleWrapper
extends InjectionLayerHolder<dev.derklaro.aerogel.Injector>

The module wrapper represents a loaded module. The wrapper holds the configuration and other runtime information about the module like the module lifecycle. The wrapper is also responsible for changing the module lifecycle of a module.

Since:

4.0

See Also:

• ModuleLifeCycle

Method Summary

Modifier and Type	Method	Description
@NonNull ClassLoader	classLoader()	Get the class loader which is responsible for this module.
@NonNull Path	dataDirectory()	Get the data directory of this module in which the module should store its configuration files.
@NonNull @Unmodifiable Set<ModuleDependency>	dependingModules()	Get all modules this module is depending on.
@NonNull InjectionLayer<dev.derklaro.aerogel.Injector>	injectionLayer()	Get the injection layer which was used while creating this module instance and is used to inject module tasks.
@NonNull ModuleWrapper	loadModule()	Changes the lifecycle of this module to ModuleLifeCycle.LOADED if possible and fires all associated tasks.
@NonNull Module	module()	Get the wrapped module instance of this wrapper.
@NonNull ModuleConfiguration	moduleConfiguration()	Get the module configuration on which base the module was created.
@NonNull ModuleLifeCycle	moduleLifeCycle()	Get the current lifecycle of this wrapper.
@NonNull ModuleProvider	moduleProvider()	Get the module provider which loaded this module.
@NonNull @Unmodifiable Map<ModuleLifeCycle, List<ModuleTaskEntry>>	moduleTasks()	Get all module tasks which were detected in the main class of the module.
@NonNull ModuleWrapper	reloadModule()	Changes the lifecycle of this module to ModuleLifeCycle.RELOADING if possible and fires all associated tasks.
@NonNull ModuleWrapper	startModule()	Changes the lifecycle of this module to ModuleLifeCycle.STARTED if possible and fires all associated tasks.
@NonNull ModuleWrapper	stopModule()	Changes the lifecycle of this module to ModuleLifeCycle.STOPPED if possible and fires all associated tasks.
@NonNull ModuleWrapper	unloadModule()	Changes the lifecycle of this module to ModuleLifeCycle.UNLOADED if possible and fires all associated tasks.
@NonNull URI	uri()	Get the uri from where the module was loaded.
@NonNull URL	url()	Get the url from where the module was loaded.

Method Details

moduleTasks

@NonNull
@NonNull @Unmodifiable Map<ModuleLifeCycle, List<ModuleTaskEntry>> moduleTasks()

Get all module tasks which were detected in the main class of the module.

Returns:

an immutable map of all module tasks which were detected in the main class of the module.

dependingModules

@NonNull
@NonNull @Unmodifiable Set<ModuleDependency> dependingModules()

Get all modules this module is depending on.

Returns:

an immutable set of all modules this module is depending on.

module

@NonNull
@NonNull Module module()

Get the wrapped module instance of this wrapper.

Returns:

the wrapped module instance of this wrapper.

moduleLifeCycle

@NonNull
@NonNull ModuleLifeCycle moduleLifeCycle()

Get the current lifecycle of this wrapper.

Returns:

the current lifecycle of this wrapper.

moduleProvider

@NonNull
@NonNull ModuleProvider moduleProvider()

Get the module provider which loaded this module.

Returns:

the module provider which loaded this module.

moduleConfiguration

@NonNull
@NonNull ModuleConfiguration moduleConfiguration()

Get the module configuration on which base the module was created.

Returns:

the module configuration on which base the module was created.

classLoader

@NonNull
@NonNull ClassLoader classLoader()

Get the class loader which is responsible for this module.

Returns:

the class loader which is responsible for this module.

loadModule

@NonNull
@NonNull ModuleWrapper loadModule()

Changes the lifecycle of this module to ModuleLifeCycle.LOADED if possible and fires all associated tasks.

Returns:

the same instance of this class, for chaining.

See Also:

• moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

startModule

@NonNull
@NonNull ModuleWrapper startModule()

Changes the lifecycle of this module to ModuleLifeCycle.STARTED if possible and fires all associated tasks.

Returns:

the same instance of this class, for chaining.

See Also:

• moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

reloadModule

@NonNull
@NonNull ModuleWrapper reloadModule()

Changes the lifecycle of this module to ModuleLifeCycle.RELOADING if possible and fires all associated tasks.

Returns:

the same instance of this class, for chaining.

See Also:

• moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

stopModule

@NonNull
@NonNull ModuleWrapper stopModule()

Changes the lifecycle of this module to ModuleLifeCycle.STOPPED if possible and fires all associated tasks.

Returns:

the same instance of this class, for chaining.

See Also:

• moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

unloadModule

@NonNull
@NonNull ModuleWrapper unloadModule()

Changes the lifecycle of this module to ModuleLifeCycle.UNLOADED if possible and fires all associated tasks. The module will be unregistered from the provider, the class loader will be closed and the state of this module changes to ModuleLifeCycle.UNUSABLE.

Returns:

the same instance of this class, for chaining.

See Also:

• moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

dataDirectory

@NonNull
@NonNull Path dataDirectory()

Get the data directory of this module in which the module should store its configuration files.

Returns:

the data directory of this module.

url

@NonNull
@NonNull URL url()

Get the url from where the module was loaded.

Returns:

the url from where the module was loaded.

uri

@NonNull
@NonNull URI uri()

Get the uri from where the module was loaded.

Returns:

the uri from where the module was loaded.

injectionLayer

@NonNull
@NonNull InjectionLayer<dev.derklaro.aerogel.Injector> injectionLayer()

Get the injection layer which was used while creating this module instance and is used to inject module tasks.

Specified by:

injectionLayer in interface InjectionLayerHolder<dev.derklaro.aerogel.Injector>

Returns:

the injection layer of the module.