Class AbstractEnforcerRule
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
- All Implemented Interfaces:
EnforcerRuleBase
Entry point for custom
Enforcer Rule
.
Please see Writing a custom rule
- Since:
- 3.2.1
- Author:
- Slawomir Jaranowski
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
execute()
This is the interface into the rule.If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.getLevel()
Current Enforcer execution levelgetLog()
Provide anEnforcerLogger
instance for Rulevoid
setLog
(EnforcerLogger log) Used byEnforcerMojo
to inject logger instance
-
Constructor Details
-
AbstractEnforcerRule
public AbstractEnforcerRule()
-
-
Method Details
-
getLevel
Current Enforcer execution level- Returns:
- an Enforcer execution level
-
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
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 exceptionEnforcerRuleError
- in order to brake a build immediately
-
setLog
Used byEnforcerMojo
to inject logger instance- Specified by:
setLog
in interfaceEnforcerRuleBase
- Parameters:
log
- anEnforcerLogger
instance
-
getLog
Provide anEnforcerLogger
instance for RuleNOTICE A logger is not available in constructors.
- Returns:
- an
EnforcerLogger
instance
-