pw.krejci.modules.maven

Interface ModuleSpecController

public interface ModuleSpecController

Can be used by the users of ProjectModule to modify the process of defining the modules and their dependencies.

This can be useful for example in situations where you need to have some classes loaded from the system classpath and not through the module system.

Field Summary

Fields

Modifier and Type	Field and Description
static ModuleSpecController	NOOP

Method Summary

Modifier and Type	Method and Description
default void	end(String moduleName) Called as the last method when processing a module of given name.
default void	modify(org.jboss.modules.ModuleSpec.Builder bld) Called after all dependencies were processed using modifyDependency(String, DependencySpec).
default org.jboss.modules.DependencySpec	modifyDependency(String dependencyName, org.jboss.modules.DependencySpec original) Gives the controller a chance to modify how a module depends on the detected dependencies.
default void	start(String moduleName) Called to inform the controller that a module with given name is about to be processed.

Field Detail

NOOP

static final ModuleSpecController NOOP

Method Detail

start

default void start(String moduleName)

Called to inform the controller that a module with given name is about to be processed.

This is the first call into the controller for any given module.

Parameters:

moduleName - the name of the module

modifyDependency

default org.jboss.modules.DependencySpec modifyDependency(String dependencyName,
                                                          org.jboss.modules.DependencySpec original)

Gives the controller a chance to modify how a module depends on the detected dependencies.

This is called after start(String) zero or more times depending on the number of dependencies automatically detected for given module.

Parameters:

dependencyName - the name of the detected dependency

original - the dependency spec as defined using the default strategy

Returns:

the original if no changed needed, a new dependency spec instance if the dependency needs to be defined different from the default or null if the dependency should be omitted altogether

modify

default void modify(org.jboss.modules.ModuleSpec.Builder bld)

Called after all dependencies were processed using modifyDependency(String, DependencySpec).

This gives the controller a chance to modify the module as a whole - add additional dependencies, change the declared version, etc.

Parameters:

bld - the builder of the module specification

end

default void end(String moduleName)

Called as the last method when processing a module of given name.

Parameters:

moduleName - the name of the module that has been processed