Class AbstractEnforcerRuleConfigProvider

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
All Implemented Interfaces:
EnforcerRuleBase
Direct Known Subclasses:
ExternalRules
public abstract class AbstractEnforcerRuleConfigProvider extends Object
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
Author:
Slawomir Jaranowski

  • Constructor Details

    • AbstractEnforcerRuleConfigProvider

      public AbstractEnforcerRuleConfigProvider()

  • Method Details

    • 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

    • 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