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

public class RequireReleaseVersion
extends AbstractNonCacheableEnforcerRule

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

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
boolean	failWhenParentIsSnapshot Deprecated. the visibility will be reduced to private with the next major version

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

Constructors

Constructor and Description
RequireReleaseVersion()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper theHelper) This is the interface into the rule.
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

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

failWhenParentIsSnapshot

public boolean failWhenParentIsSnapshot

Deprecated. the visibility will be reduced to private with the next major version

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

isFailWhenParentIsSnapshot

public final boolean isFailWhenParentIsSnapshot()

setFailWhenParentIsSnapshot

public final void setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)