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
- Since:
- 1.3
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Can either be version or a range, e.g.Only the projects with one of these packagings will be enforced to have the correct prerequisite. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute
(EnforcerRuleHelper helper) This is the interface into the rule.void
setMavenVersion
(String mavenVersion) Set the mavenVersion Can either be version or a range, e.g.void
setPackagings
(List<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
-
Field Details
-
packagings
Only the projects with one of these packagings will be enforced to have the correct prerequisite.- Since:
- 1.4
-
mavenVersion
Can either be version or a range, e.g.2.2.1
or[2.2.1,)
-
-
Constructor Details
-
RequirePrerequisite
public RequirePrerequisite()
-
-
Method Details
-
setMavenVersion
Set the mavenVersion Can either be version or a range, e.g.2.2.1
or[2.2.1,)
- Parameters:
mavenVersion
- the version ornull
-
setPackagings
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
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 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
-