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
public abstract class AbstractEnforcerRuleConfigProvider extends AbstractEnforcerRuleBase
Entry point for customEnforcer 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 Constructor Description AbstractEnforcerRuleConfigProvider()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract org.codehaus.plexus.util.xml.Xpp3Dom
getRulesConfig()
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, getRuleName
-
-
-
-
Method Detail
-
getRulesConfig
public abstract org.codehaus.plexus.util.xml.Xpp3Dom getRulesConfig() throws EnforcerRuleError
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
-
-