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

Class RequireProperty

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.property.RequireProperty
All Implemented Interfaces:
EnforcerRuleBase
@Named("requireProperty") public final class RequireProperty extends AbstractStandardEnforcerRule
This rule checks that certain properties are set.
Author:
Paul Gier

  • Constructor Details

  • Method Details

    • setProperty

      public void setProperty(String property)

    • resolveValue

      public Object resolveValue() throws EnforcerRuleException
      Resolves the property value
      Returns:
      a resolve value
      Throws:
      EnforcerRuleException - in case of problems

    • getPropertyName

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

    • getName

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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
      EnforcerRuleError - in order to brake a build immediately

    • 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