Package org.apache.maven.enforcer.rules

Class ExternalRules

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider

org.apache.maven.enforcer.rules.ExternalRules

All Implemented Interfaces:

EnforcerRuleBase

@Named("externalRules")
public final class ExternalRules
extends AbstractEnforcerRuleConfigProvider

An enforcer rule that will provide rules configuration from an external resource.

Since:

3.2.0

Author:

George Gastaldi

Constructor Summary

Constructors

Constructor	Description
ExternalRules(org.apache.maven.plugin.MojoExecution mojoExecution, ExpressionEvaluator evaluator)

Method Summary

Modifier and Type	Method	Description
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
org.codehaus.plexus.util.xml.Xpp3Dom	getRulesConfig()	Produce rule configuration.
void	setLocation(String location)
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

getLevel

Constructor Details

ExternalRules

@Inject
public ExternalRules(org.apache.maven.plugin.MojoExecution mojoExecution,
 ExpressionEvaluator evaluator)

Method Details

setLocation

public void setLocation(String location)

getRulesConfig

public org.codehaus.plexus.util.xml.Xpp3Dom getRulesConfig()
                                                    throws EnforcerRuleError

Description copied from class: AbstractEnforcerRuleConfigProvider

Produce rule configuration.

Returned configuration must contain rules configuration as in example:

     <rules>
         <ruleName/>
         <ruleName>
             <ruleConfig>config value</ruleConfig>
         </ruleName>
     </rules>
 

Specified by:

getRulesConfig in class AbstractEnforcerRuleConfigProvider

Returns:

a rules configuration

Throws:

EnforcerRuleError - the error during 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