Class RequirePrerequisite
- java.lang.Object
-
- org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
-
- org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
-
- org.apache.maven.plugins.enforcer.RequirePrerequisite
-
- All Implemented Interfaces:
EnforcerRule,EnforcerRule2
public class RequirePrerequisite extends AbstractNonCacheableEnforcerRule
- Since:
- 1.3
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.StringmavenVersionCan either be version or a range, e.g.private java.util.List<java.lang.String>packagingsOnly the projects with one of these packagings will be enforced to have the correct prerequisite.
-
Constructor Summary
Constructors Constructor Description RequirePrerequisite()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidexecute(EnforcerRuleHelper helper)This is the interface into the rule.voidsetMavenVersion(java.lang.String mavenVersion)Set the mavenVersion Can either be version or a range, e.g.voidsetPackagings(java.util.List<java.lang.String> packagings)Only the projects with one of these packagings will be enforced to have the correct prerequisite.-
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid
-
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage
-
-
-
-
Method Detail
-
setMavenVersion
public void setMavenVersion(java.lang.String mavenVersion)
Set the mavenVersion Can either be version or a range, e.g.2.2.1or[2.2.1,)- Parameters:
mavenVersion- the version ornull
-
setPackagings
public void setPackagings(java.util.List<java.lang.String> packagings)
Only the projects with one of these packagings will be enforced to have the correct prerequisite.- Parameters:
packagings- the list of packagings- Since:
- 1.4
-
execute
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
Description copied from interface:EnforcerRuleThis 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 if it should stop or just log the message as a warning.- Parameters:
helper- The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.- Throws:
EnforcerRuleException- the enforcer rule exception
-
-