Class RequireMavenVersion

All Implemented Interfaces:

@Named("requireMavenVersion") public final class RequireMavenVersion extends AbstractStandardEnforcerRule
This rule checks that the Maven version is allowed.
Brian Fox
  • Constructor Details

    • RequireMavenVersion

      @Inject public RequireMavenVersion(org.apache.maven.rtinfo.RuntimeInformation runtimeInformation)
  • Method Details

    • 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
      EnforcerRuleException - the enforcer rule exception
    • toString

      public String toString()
      toString in class Object
    • enforceVersion

      public void enforceVersion(String variableName, String requiredVersionRange, org.apache.maven.artifact.versioning.ArtifactVersion actualVersion) throws EnforcerRuleException
      Compares the specified version to see if it is allowed by the defined version range.
      variableName - name of variable to use in messages (Example: "Maven" or "Java" etc).
      requiredVersionRange - range of allowed versions.
      actualVersion - the version to be checked.
      EnforcerRuleException - the enforcer rule exception
    • toString

      protected static String toString(org.apache.maven.artifact.versioning.VersionRange vr)
    • getCacheId

      public String getCacheId()
      Description copied from class: AbstractEnforcerRule
      If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.

      Rule of the same class and the same cache id will be executed once.

      getCacheId in class AbstractEnforcerRule
      id to be used by the Enforcer to determine uniqueness of cache results. Return null disable cache of rule executing.
    • getVersion

      public final String getVersion()
      Gets the required version.
      the required version
    • setVersion

      public void setVersion(String theVersion)
      Specify the required version. Some examples are:
      • 2.0.4 Version 2.0.4 and higher (different from Maven meaning)
      • [2.0,2.1) Versions 2.0 (included) to 2.1 (not included)
      • [2.0,2.1] Versions 2.0 to 2.1 (both included)
      • [2.0.5,) Versions 2.0.5 and higher
      • (,2.0.5],[2.1.1,) Versions up to 2.0.5 (included) and 2.1.1 or higher
      theVersion - the required version to set
    • setLog

      public void setLog(EnforcerLogger log)
      Used by EnforcerMojo to inject logger instance
      Specified by:
      setLog in interface EnforcerRuleBase
      log - an EnforcerLogger instance
    • getLog

      public EnforcerLogger getLog()
      Provide an EnforcerLogger instance for Rule

      NOTICE A logger is not available in constructors.

      an EnforcerLogger instance