Package org.apache.maven.enforcer.rules

Class ExternalRules

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider

org.apache.maven.enforcer.rules.ExternalRules

All Implemented Interfaces:

EnforcerRuleBase

@Named("externalRules")
public final class ExternalRules
extends AbstractEnforcerRuleConfigProvider

An enforcer rule that will provide rules configuration from an external resource.

Since:

3.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ExpressionEvaluator	evaluator
private String	location	The external rules location.
private static final String	LOCATION_PREFIX_CLASSPATH
private final org.apache.maven.plugin.MojoExecution	mojoExecution

Constructor Summary

Constructors

Constructor	Description
ExternalRules(org.apache.maven.plugin.MojoExecution mojoExecution, ExpressionEvaluator evaluator)

Method Summary

Modifier and Type	Method	Description
org.codehaus.plexus.util.xml.Xpp3Dom	getRulesConfig()	Produce rule configuration.
private InputStream	resolveDescriptor()
void	setLocation(String location)
String	toString()

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

Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

getLevel

Field Details

LOCATION_PREFIX_CLASSPATH

private static final String LOCATION_PREFIX_CLASSPATH

See Also:

• Constant Field Values

location

private String location

The external rules location. If it starts with "classpath:", the resource is read from the classpath. Otherwise, it is handled as a filesystem path, either absolute, or relative to ${project.basedir}

mojoExecution

private final org.apache.maven.plugin.MojoExecution mojoExecution

evaluator

private final ExpressionEvaluator evaluator

Constructor Details

ExternalRules

@Inject
public ExternalRules(org.apache.maven.plugin.MojoExecution mojoExecution,
 ExpressionEvaluator evaluator)

Method Details

setLocation

public void setLocation(String location)

getRulesConfig

public org.codehaus.plexus.util.xml.Xpp3Dom getRulesConfig()
                                                    throws EnforcerRuleError

Description copied from class: AbstractEnforcerRuleConfigProvider

Produce rule configuration.

Returned configuration must contain rules configuration as in example:

     <rules>
         <ruleName/>
         <ruleName>
             <ruleConfig>config value</ruleConfig>
         </ruleName>
     </rules>
 

Specified by:

getRulesConfig in class AbstractEnforcerRuleConfigProvider

Returns:

a rules configuration

Throws:

EnforcerRuleError - the error during executing

resolveDescriptor

private InputStream resolveDescriptor()
                               throws EnforcerRuleError

Throws:

EnforcerRuleError

toString

public String toString()

Overrides:

toString in class Object