Class AbstractPropertyEnforcerRule

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String regex
      Match the property value to a given regular expression.
      private java.lang.String regexMessage
      Specify a warning message if the regular expression is not matched.
    • Field Detail

      • regex

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

        private java.lang.String regexMessage
        Specify a warning message if the regular expression is not matched.
    • Constructor Detail

      • AbstractPropertyEnforcerRule

        AbstractPropertyEnforcerRule()
    • Method Detail

      • setRegex

        public final void setRegex​(java.lang.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 java.lang.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​(java.lang.String regexMessage)
        Set a warning message if the regular expression is not matched.
        Parameters:
        regexMessage - the regex message
      • getRegexMessage

        public final java.lang.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
      • getName

        protected abstract java.lang.String getName()
        How the property that is being evaluated is called
        Returns:
        kind of property
      • getPropertyName

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