Package org.apache.maven.enforcer.rules

Class ReactorModuleConvergence

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.ReactorModuleConvergence

All Implemented Interfaces:

EnforcerRuleBase

@Named("reactorModuleConvergence")
public final class ReactorModuleConvergence
extends AbstractStandardEnforcerRule

This rule will check if a multi module build will follow the best practices.

Since:

1.4

Author:

Karl-Heinz Marbaise

Constructor Summary

Constructors

Constructor	Description
ReactorModuleConvergence(org.apache.maven.execution.MavenSession session)

Method Summary

Modifier and Type	Method	Description
void	execute()	This is the interface into the rule.
String	getCacheId()	If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
boolean	isIgnoreModuleDependencies()
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
String	toString()

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

getLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ReactorModuleConvergence

@Inject
public ReactorModuleConvergence(org.apache.maven.execution.MavenSession session)

Method Details

execute

public void execute()
             throws EnforcerRuleException

Description copied from class: AbstractEnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - in order to brake a build immediately

isIgnoreModuleDependencies

public boolean isIgnoreModuleDependencies()

getCacheId

public String getCacheId()

Description copied from class: AbstractEnforcerRule

If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.

Rule of the same class and the same cache id will be executed once.

Overrides:

getCacheId in class AbstractEnforcerRule

Returns:

id to be used by the Enforcer to determine uniqueness of cache results. Return null disable cache of rule executing.

toString

public String toString()

Overrides:

toString in class Object

setLog

public void setLog(EnforcerLogger log)

Used by EnforcerMojo to inject logger instance

Specified by:

setLog in interface EnforcerRuleBase

Parameters:

log - an EnforcerLogger instance

getLog

public EnforcerLogger getLog()

Provide an EnforcerLogger instance for Rule

NOTICE A logger is not available in constructors.

Returns:

an EnforcerLogger instance