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
Abstract enforcer rule that give a foundation to validate properties from multiple sources.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute
(EnforcerRuleHelper helper) This is the interface into the rule.abstract String
getName()
How the property that is being evaluated is calledabstract String
The name of the property currently being evaluated, this is used for default message pourpouses onlyfinal String
getRegex()
Get the property value to a given regular expression.final String
Get a warning message if the regular expression is not matched.abstract Object
resolveValue
(EnforcerRuleHelper helper) Resolves the property valuefinal void
Set the property value to a given regular expression.final void
setRegexMessage
(String regexMessage) Set a warning message if the regular expression is not matched.Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage
-
Field Details
-
regex
Match the property value to a given regular expression. Defaults tonull
(any value is ok). -
regexMessage
Specify a warning message if the regular expression is not matched.
-
-
Constructor Details
-
AbstractPropertyEnforcerRule
public AbstractPropertyEnforcerRule()
-
-
Method Details
-
setRegex
Set the property value to a given regular expression. Defaults tonull
(any value is ok).- Parameters:
regex
- The regular expression
-
getRegex
Get the property value to a given regular expression. Defaults tonull
(any value is ok).- Returns:
- the regular expression
-
setRegexMessage
Set a warning message if the regular expression is not matched.- Parameters:
regexMessage
- the regex message
-
getRegexMessage
Get a warning message if the regular expression is not matched.- Returns:
- the regex message
-
execute
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
How the property that is being evaluated is called -
getPropertyName
The name of the property currently being evaluated, this is used for default message pourpouses only -
resolveValue
Resolves the property value- Parameters:
helper
-- Throws:
EnforcerRuleException
-