Class AbstractEnforcerRule
- java.lang.Object
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
- All Implemented Interfaces:
EnforcerRuleBase
- Direct Known Subclasses:
AbstractStandardEnforcerRule
public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase
Entry point for customEnforcer Rule
.Please see Writing a custom rule
- Since:
- 3.2.1
-
-
Field Summary
Fields Modifier and Type Field Description private EnforcerLevel
level
Enforcer Rule execution levelprivate java.lang.String
ruleName
Rule name for current rule instance.
-
Constructor Summary
Constructors Constructor Description AbstractEnforcerRule()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
execute()
This is the interface into the rule.java.lang.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 leveljava.lang.String
getRuleName()
Rule name for current rule instance.-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
Field Detail
-
level
private EnforcerLevel level
Enforcer Rule execution level
-
ruleName
private java.lang.String ruleName
Rule name for current rule instance.
-
-
Method Detail
-
getLevel
public EnforcerLevel getLevel()
Current Enforcer execution level- Returns:
- an Enforcer execution level
-
getRuleName
public java.lang.String getRuleName()
Rule name for current rule instance.- Returns:
- a rule name.
- Since:
- 3.6.0
-
getCacheId
public java.lang.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 exceptionEnforcerRuleError
- in order to brake a build immediately
-
-