Package org.apache.maven.plugins.enforcer

Class AbstractPropertyEnforcerRule

java.lang.Object
org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule
All Implemented Interfaces:
EnforcerRule, EnforcerRule2
Direct Known Subclasses:
RequireEnvironmentVariable, RequireProperty
public abstract class AbstractPropertyEnforcerRule extends AbstractNonCacheableEnforcerRule
Abstract enforcer rule that give a foundation to validate properties from multiple sources.

  • Field Details

    • regex

      private String regex
      Match the property value to a given regular expression. Defaults to null (any value is ok).

    • regexMessage

      private String regexMessage
      Specify a warning message if the regular expression is not matched.

  • Constructor Details

    • AbstractPropertyEnforcerRule

      public AbstractPropertyEnforcerRule()

  • Method Details

    • setRegex

      public final void setRegex(String regex)
      Set the property value to a given regular expression. Defaults to null (any value is ok).
      Parameters:
      regex - The regular expression

    • getRegex

      public final String getRegex()
      Get the property value to a given regular expression. Defaults to null (any value is ok).
      Returns:
      the regular expression

    • setRegexMessage

      public final void setRegexMessage(String regexMessage)
      Set a warning message if the regular expression is not matched.
      Parameters:
      regexMessage - the regex message

    • getRegexMessage

      public final String getRegexMessage()
      Get a warning message if the regular expression is not matched.
      Returns:
      the regex message

    • 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

    • getName

      protected abstract String getName()
      How the property that is being evaluated is called
      Returns:
      kind of property

    • getPropertyName

      protected abstract String getPropertyName()
      The name of the property currently being evaluated, this is used for default message purposes only
      Returns:
      the name of the property

    • resolveValue

      protected abstract Object resolveValue(EnforcerRuleHelper helper) throws EnforcerRuleException
      Resolves the property value
      Parameters:
      helper -
      Throws:
      EnforcerRuleException