RequireSnapshotVersion

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.RequireSnapshotVersion

All Implemented Interfaces:: EnforcerRuleBase

@Named("requireSnapshotVersion")
public final class RequireSnapshotVersion
extends AbstractStandardEnforcerRule

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.
`private org.apache.maven.project.MavenProject`	`project`

Constructor Summary

Constructors
Constructor Description

RequireSnapshotVersion(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`	`setFailWhenParentIsRelease(boolean failWhenParentIsRelease)`
`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, getRuleName

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - failWhenParentIsRelease
```
private boolean failWhenParentIsRelease
```
    Allows this rule to fail when the parent is defined as a release.
  - project
```
private final org.apache.maven.project.MavenProject project
```
- Constructor Detail
  - RequireSnapshotVersion
```
@Inject
public RequireSnapshotVersion(org.apache.maven.project.MavenProject project)
```
- Method Detail
  - 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 class AbstractEnforcerRule
    
    Throws:
    
    EnforcerRuleException - the enforcer rule exception
    
    EnforcerRuleError - in order to brake a build immediately
  - setFailWhenParentIsRelease
```
public void setFailWhenParentIsRelease(boolean failWhenParentIsRelease)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object