org.apache.maven.plugins.enforcer

Class RequireReleaseVersion

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.RequireReleaseVersion

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireReleaseVersion
extends AbstractNonCacheableEnforcerRule

This rule checks that the current project is not a snapshot.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	failWhenParentIsSnapshot Allows this rule to fail when the parent is defined as a snapshot.

Constructor Summary

Constructors

Constructor and Description
RequireReleaseVersion()

Method Summary

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper theHelper) This is the interface into the rule.
private org.apache.maven.project.MavenProject	getProject(EnforcerRuleHelper helper)
boolean	isFailWhenParentIsSnapshot()
void	setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

failWhenParentIsSnapshot

private boolean failWhenParentIsSnapshot

Allows this rule to fail when the parent is defined as a snapshot.

See Also:

#setFailWhenParentIsSnapshot(boolean)}, #isFailWhenParentIsSnapshot()}

Constructor Detail

RequireReleaseVersion

public RequireReleaseVersion()

Method Detail

execute

public void execute(EnforcerRuleHelper theHelper)
             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:

theHelper - 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(EnforcerRuleHelper helper)
                                                  throws EnforcerRuleException

Parameters:

helper -

Returns:

The evaluated MavenProject.

Throws:

EnforcerRuleException

isFailWhenParentIsSnapshot

public final boolean isFailWhenParentIsSnapshot()

setFailWhenParentIsSnapshot

public final void setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)