Package org.apache.maven.enforcer.rules.version

Class RequireJavaVersion

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.version.RequireJavaVersion
All Implemented Interfaces:
EnforcerRuleBase
@Named("requireJavaVersion") public final class RequireJavaVersion extends AbstractStandardEnforcerRule
This rule checks that the Java version is allowed.
Author:
Brian Fox

  • Constructor Details

  • Method Details

    • setVersion

      public void setVersion(String version)
      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
      Parameters:
      version - the required version to set

    • 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

    • normalizeJDKVersion

      public static String normalizeJDKVersion(String jdkVersion)
      Converts a JDK string from 1.5.0-11b12 to a single 3 digit version like 1.5.0-11
      Parameters:
      jdkVersion - to be converted
      Returns:
      the converted string

    • toString

      public String toString()
      Overrides:
      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.
      Parameters:
      variableName - name of variable to use in messages. For example, "Maven" or "Java".
      requiredVersionRange - range of allowed versions
      actualVersion - the version to be checked
      Throws:
      EnforcerRuleException - the enforcer rule exception

    • toString

      protected static String toString(org.apache.maven.artifact.versioning.VersionRange versionRange)

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

      Overrides:
      getCacheId in class AbstractEnforcerRule
      Returns:
      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.
      Returns:
      the required version

    • setLog

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

    • getLog

      public EnforcerLogger getLog()
      Provide an EnforcerLogger instance for Rule

      NOTICE A logger is not available in constructors.

      Returns:
      an EnforcerLogger instance