Class RequireSnapshotVersion
- java.lang.Object
-
- org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
-
- org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
-
- org.apache.maven.plugins.enforcer.RequireSnapshotVersion
-
- All Implemented Interfaces:
EnforcerRule
,EnforcerRule2
public class RequireSnapshotVersion extends AbstractNonCacheableEnforcerRule
This rule checks that the current project is not a release.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
failWhenParentIsRelease
Allows this rule to fail when the parent is defined as a release.
-
Constructor Summary
Constructors Constructor Description RequireSnapshotVersion()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(EnforcerRuleHelper helper)
This is the interface into the rule.private org.apache.maven.project.MavenProject
getProject(boolean parent, EnforcerRuleHelper helper)
boolean
isFailWhenParentIsRelease()
void
setFailWhenParentIsRelease(boolean failWhenParentIsRelease)
-
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
-
execute
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
Description copied from interface:EnforcerRule
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
-
getProject
private org.apache.maven.project.MavenProject getProject(boolean parent, EnforcerRuleHelper helper) throws EnforcerRuleException
- Throws:
EnforcerRuleException
-
isFailWhenParentIsRelease
public boolean isFailWhenParentIsRelease()
-
setFailWhenParentIsRelease
public void setFailWhenParentIsRelease(boolean failWhenParentIsRelease)
-
-