Package org.apache.maven.enforcer.rule.api

Class AbstractEnforcerRuleConfigProvider

  • All Implemented Interfaces:
    EnforcerRuleBase
    Direct Known Subclasses:
    ExternalRules
    public abstract class AbstractEnforcerRuleConfigProvider
extends AbstractEnforcerRuleBase
    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 Detail

      • AbstractEnforcerRuleConfigProvider

        public AbstractEnforcerRuleConfigProvider()

    • 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