Class RequireReleaseVersion

All Implemented Interfaces:
EnforcerRule, EnforcerRule2

public class RequireReleaseVersion extends AbstractNonCacheableEnforcerRule
This rule checks that the current project is not a snapshot.
  • Field Details

    • failWhenParentIsSnapshot

      private boolean failWhenParentIsSnapshot
      Allows this rule to fail when the parent is defined as a snapshot.
  • Constructor Details

    • RequireReleaseVersion

      public RequireReleaseVersion()
  • Method Details

    • 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)