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

Class AbstractEnforcerRule

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

All Implemented Interfaces:

EnforcerRuleBase

public abstract class AbstractEnforcerRule
extends Object

Entry point for custom Enforcer Rule.

Please see Writing a custom rule

Since:

3.2.1

Author:

Slawomir Jaranowski

Constructor Summary

Constructors

Constructor	Description
AbstractEnforcerRule()

Method Summary

Modifier and Type	Method	Description
abstract void	execute()	This is the interface into the rule.
String	getCacheId()	If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.
EnforcerLevel	getLevel()	Current Enforcer execution level
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
String	getRuleName()	Rule name for current rule instance.
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEnforcerRule

public AbstractEnforcerRule()

Method Details

getLevel

public EnforcerLevel getLevel()

Current Enforcer execution level

Returns:

an Enforcer execution level

getRuleName

public String getRuleName()

Rule name for current rule instance.

Returns:

a rule name.

Since:

3.6.0

getCacheId

public String getCacheId()

If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.

Rule of the same class and the same cache id will be executed once.

Returns:

id to be used by the Enforcer to determine uniqueness of cache results. Return null disable cache of rule executing.

execute

public abstract void execute()
                      throws EnforcerRuleException

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - in order to brake a build immediately

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