Package org.apache.maven.enforcer.rules.property

Class AbstractPropertyEnforcerRule

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.property.AbstractPropertyEnforcerRule
All Implemented Interfaces:
EnforcerRuleBase
Direct Known Subclasses:
RequireEnvironmentVariable, RequireProperty
abstract class AbstractPropertyEnforcerRule extends AbstractStandardEnforcerRule
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

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

    • 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() throws EnforcerRuleException
      Resolves the property value
      Returns:
      a resolve value
      Throws:
      EnforcerRuleException - in case of problems