Class AbstractEnforcerRuleConfigProvider
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
- All Implemented Interfaces:
EnforcerRuleBase
Entry point for custom
Enforcer Rule
which provide additional rules configuration.
Provided configuration will be added to current rules list by Enforcer Mojo
- Since:
- 3.2.0
- Author:
- Slawomir Jaranowski
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetLog()
Provide anEnforcerLogger
instance for Ruleabstract org.codehaus.plexus.util.xml.Xpp3Dom
Produce rule configuration.void
setLog
(EnforcerLogger log) Used byEnforcerMojo
to inject logger instanceMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase
getLevel
-
Constructor Details
-
AbstractEnforcerRuleConfigProvider
public AbstractEnforcerRuleConfigProvider()
-
-
Method Details
-
getRulesConfig
Produce rule configuration.Returned configuration must contain rules configuration as in example:
<rules> <ruleName/> <ruleName> <ruleConfig>config value</ruleConfig> </ruleName> </rules>
- Returns:
- a rules configuration
- Throws:
EnforcerRuleError
- the error during executing
-
setLog
Used byEnforcerMojo
to inject logger instance- Specified by:
setLog
in interfaceEnforcerRuleBase
- Parameters:
log
- anEnforcerLogger
instance
-
getLog
Provide anEnforcerLogger
instance for RuleNOTICE A logger is not available in constructors.
- Returns:
- an
EnforcerLogger
instance
-