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 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

Constructor	Description
AbstractEnforcerRuleConfigProvider()

Method Summary

Modifier and Type	Method	Description
abstract org.codehaus.plexus.util.xml.Xpp3Dom	getRulesConfig()	Produce rule configuration.

Methods inherited from class AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EnforcerRuleBase

getLevel, getRuleName

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