Interface ModuleProvider

public interface ModuleProvider

The module provider allows access to all loaded modules and the module paths. It keeps track of all known modules and provides access their module wrapper and changing the module lifecycle for the modules.

Since:

4.0

See Also:

• ModuleWrapper
• ModuleLifeCycle
• ModuleProviderHandler

Method Summary

Modifier and Type	Method	Description
@NonNull ModuleProvider	loadAll()	Loads all modules which files are located at the module directory.
@Nullable ModuleWrapper	loadModule(@NonNull URL url)	Loads a module from the given url.
@Nullable ModuleWrapper	loadModule(@NonNull Path path)	Loads the module by the file provided by the given path.
@Nullable ModuleWrapper	module(@NonNull String name)	Get a module by the given name.
@NonNull ModuleDependencyLoader	moduleDependencyLoader()	Get the module dependency loader.
void	moduleDependencyLoader(@NonNull ModuleDependencyLoader moduleDependencyLoader)	Sets the module dependency loader which should be used by this provider.
@NonNull Path	moduleDirectoryPath()	Get the base directory of this module provider.
void	moduleDirectoryPath(@NonNull Path moduleDirectory)	Sets the base directory of this module provider.
@Nullable ModuleProviderHandler	moduleProviderHandler()	Get the module provider handler of this provider or null when no handler is specified.
void	moduleProviderHandler(@Nullable ModuleProviderHandler moduleProviderHandler)	Sets the module provider handler of this provider.
@NonNull @Unmodifiable Collection<ModuleWrapper>	modules()	Get all loaded, started, stopped modules provided by this provider.
@NonNull @Unmodifiable Collection<ModuleWrapper>	modules(@NonNull String group)	Get all loaded, started, stopped modules provided by this provider which have the specific given group.
void	notifyPostModuleLifecycleChange(@NonNull ModuleWrapper wrapper, @NonNull ModuleLifeCycle lifeCycle)	Called by an ModuleWrapper when the module changed its lifecycle state.
boolean	notifyPreModuleLifecycleChange(@NonNull ModuleWrapper wrapper, @NonNull ModuleLifeCycle lifeCycle)	Called by an ModuleWrapper when the module is about to change its lifecycle state.
@NonNull ModuleProvider	reloadAll()	Reloads all modules which are loaded by this provided and can change to the started state.
@NonNull ModuleProvider	startAll()	Starts all modules which are loaded by this provided and can change to the started state.
@NonNull ModuleProvider	stopAll()	Stops all modules which are loaded by this provided and can change to the stopped state.
@NonNull ModuleProvider	unloadAll()	Unloads all modules which are loaded by this provided and can change to the unloaded state.

Method Details

moduleDirectoryPath

@NonNull
@NonNull Path moduleDirectoryPath()

Get the base directory of this module provider. It will be used to provide the data directory for modules which did not specifically set a data directory.

Returns:

the base directory of this module provider.

See Also:

• moduleDirectoryPath(Path)

moduleDirectoryPath

void moduleDirectoryPath(@NonNull
 @NonNull Path moduleDirectory)

Sets the base directory of this module provider. It will be used to provide the data directory for modules which did not specifically set a data directory.

Parameters:

moduleDirectory - the module directory to use.

Throws:

NullPointerException - if moduleDirectory is null.

See Also:

• moduleDirectoryPath()

moduleProviderHandler

@Nullable
@Nullable ModuleProviderHandler moduleProviderHandler()

Get the module provider handler of this provider or null when no handler is specified.

Returns:

the module provider handler of this provider or null.

See Also:

• moduleProviderHandler(ModuleProviderHandler)

moduleProviderHandler

void moduleProviderHandler(@Nullable
 @Nullable ModuleProviderHandler moduleProviderHandler)

Sets the module provider handler of this provider.

Parameters:

moduleProviderHandler - the new module provider to use or null when no handler should be used.

Throws:

NullPointerException - if the given module provider handler is null.

See Also:

• moduleProviderHandler()

moduleDependencyLoader

@NonNull
@NonNull ModuleDependencyLoader moduleDependencyLoader()

Get the module dependency loader. It's used to load all dependencies of all modules.

Returns:

the module provider handler used for this provider.

See Also:

• moduleDependencyLoader(ModuleDependencyLoader)

moduleDependencyLoader

void moduleDependencyLoader(@NonNull
 @NonNull ModuleDependencyLoader moduleDependencyLoader)

Sets the module dependency loader which should be used by this provider.

Parameters:

moduleDependencyLoader - the module dependency loader to use.

Throws:

NullPointerException - if moduleDependencyLoader is null.

See Also:

• moduleDependencyLoader()

modules

@NonNull
@NonNull @Unmodifiable Collection<ModuleWrapper> modules()

Get all loaded, started, stopped modules provided by this provider.

Returns:

an immutable set of all loaded, started, stopped modules provided by this provider.

See Also:

• ModuleLifeCycle

modules

@NonNull
@NonNull @Unmodifiable Collection<ModuleWrapper> modules(@NonNull
 @NonNull String group)

Get all loaded, started, stopped modules provided by this provider which have the specific given group.

Parameters:

group - the group id of the modules to get.

Returns:

an immutable set of all loaded, started, stopped modules provided by this provider which have the specific given group.

Throws:

NullPointerException - if group is null.

See Also:

• ModuleLifeCycle

module

@Nullable
@Nullable ModuleWrapper module(@NonNull
 @NonNull String name)

Get a module by the given name.

Parameters:

name - the name of the module to get.

Returns:

the module associated with the name or null if no such module is loaded.

Throws:

NullPointerException - if name is null.

loadModule

@Nullable
@Nullable ModuleWrapper loadModule(@NonNull
 @NonNull URL url)

Loads a module from the given url.

Parameters:

url - the url to load the module from.

Returns:

the loaded module or null if checks failed or a module from this url is already loaded.

Throws:

ModuleConfigurationNotFoundException - if the file associated with the url doesn't contain a module.json.

NullPointerException - if required properties are missing in dependency or repository information.

AssertionError - if any exception occurs during the load of the module.

NullPointerException - if url is null.

loadModule

@Nullable
@Nullable ModuleWrapper loadModule(@NonNull
 @NonNull Path path)

Loads the module by the file provided by the given path.

Parameters:

path - the path to load the module from.

Returns:

the loaded module or null if checks failed or a module from this path is already loaded.

Throws:

ModuleConfigurationNotFoundException - if the file associated with the url doesn't contain a module.json.

NullPointerException - if required properties are missing in dependency or repository information.

AssertionError - if any exception occurs during the load of the module.

NullPointerException - if path is null.

See Also:

• loadModule(URL)

loadAll

@NonNull
@NonNull ModuleProvider loadAll()

Loads all modules which files are located at the module directory.

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

startAll

@NonNull
@NonNull ModuleProvider startAll()

Starts all modules which are loaded by this provided and can change to the started state.

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

reloadAll

@NonNull
@NonNull ModuleProvider reloadAll()

Reloads all modules which are loaded by this provided and can change to the started state.

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

stopAll

@NonNull
@NonNull ModuleProvider stopAll()

Stops all modules which are loaded by this provided and can change to the stopped state.

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

unloadAll

@NonNull
@NonNull ModuleProvider unloadAll()

Unloads all modules which are loaded by this provided and can change to the unloaded state.

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

notifyPreModuleLifecycleChange

boolean notifyPreModuleLifecycleChange(@NonNull
 @NonNull ModuleWrapper wrapper,
 @NonNull
 @NonNull ModuleLifeCycle lifeCycle)

Called by an ModuleWrapper when the module is about to change its lifecycle state.

Parameters:

wrapper - the wrapper which is changing the lifecycle.

lifeCycle - the lifecycle the wrapper want's to change to.

Returns:

If the wrapper is allowed to change the lifecycle to the provided lifecycle.

Throws:

NullPointerException - if wrapper or lifeCycle is null.

notifyPostModuleLifecycleChange

void notifyPostModuleLifecycleChange(@NonNull
 @NonNull ModuleWrapper wrapper,
 @NonNull
 @NonNull ModuleLifeCycle lifeCycle)

Called by an ModuleWrapper when the module changed its lifecycle state.

Parameters:

wrapper - the wrapper which changed the lifecycle.

lifeCycle - the lifecycle the wrapper changed to.

Throws:

NullPointerException - if wrapper or lifeCycle is null.