Package org.apache.maven.plugins.enforcer

Class RequirePrerequisite

java.lang.Object
org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
org.apache.maven.plugins.enforcer.RequirePrerequisite
All Implemented Interfaces:
EnforcerRule, EnforcerRule2
public class RequirePrerequisite extends AbstractNonCacheableEnforcerRule
Since:
1.3

  • Field Details

    • packagings

      private List<String> packagings
      Only the projects with one of these packagings will be enforced to have the correct prerequisite.
      Since:
      1.4

    • mavenVersion

      private String mavenVersion
      Can either be version or a range, e.g. 2.2.1 or [2.2.1,)

  • Constructor Details

    • RequirePrerequisite

      public RequirePrerequisite()

  • Method Details

    • setMavenVersion

      public void setMavenVersion(String mavenVersion)
      Set the mavenVersion Can either be version or a range, e.g. 2.2.1 or [2.2.1,)
      Parameters:
      mavenVersion - the version or null

    • setPackagings

      public void setPackagings(List<String> packagings)
      Only the projects with one of these packagings will be enforced to have the correct prerequisite.
      Parameters:
      packagings - the list of packagings
      Since:
      1.4

    • 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