Class AbstractEnforcerRuleConfigProvider
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
- All Implemented Interfaces:
EnforcerRuleBase
- Direct Known Subclasses:
ExternalRules
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.1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract org.codehaus.plexus.util.xml.Xpp3Dom
Produce rule configuration.Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
Methods 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
-