Package org.apache.maven.enforcer.rules
Class RequirePrerequisite
- java.lang.Object
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
- org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
-
- org.apache.maven.enforcer.rules.RequirePrerequisite
-
- All Implemented Interfaces:
EnforcerRuleBase
@Named("requirePrerequisite") public final class RequirePrerequisite extends AbstractStandardEnforcerRule
- Since:
- 1.3
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
mavenVersion
Can either be version or a range, e.g.private java.util.List<java.lang.String>
packagings
Only the projects with one of these packagings will be enforced to have the correct prerequisite.private org.apache.maven.project.MavenProject
project
-
Constructor Summary
Constructors Constructor Description RequirePrerequisite(org.apache.maven.project.MavenProject project)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
This is the interface into the rule.void
setMavenVersion(java.lang.String mavenVersion)
Set the mavenVersion Can either be version or a range, e.g.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.java.lang.String
toString()
-
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
Field Detail
-
packagings
private java.util.List<java.lang.String> packagings
Only the projects with one of these packagings will be enforced to have the correct prerequisite.- Since:
- 1.4
-
mavenVersion
private java.lang.String mavenVersion
Can either be version or a range, e.g.2.2.1
or[2.2.1,)
-
project
private final org.apache.maven.project.MavenProject project
-
-
Method Detail
-
setMavenVersion
public void setMavenVersion(java.lang.String mavenVersion)
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
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() throws EnforcerRuleException
Description copied from class:AbstractEnforcerRule
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.- Specified by:
execute
in classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- in order to brake a build immediately
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-