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 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.
-
Constructor Summary
Constructors Constructor Description AbstractPropertyEnforcerRule()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
execute(EnforcerRuleHelper helper)
This is the interface into the rule.abstract java.lang.String
getName()
How the property that is being evaluated is calledabstract java.lang.String
getPropertyName()
The name of the property currently being evaluated, this is used for default message pourpouses onlyjava.lang.String
getRegex()
Get the property value to a given regular expression.java.lang.String
getRegexMessage()
Get a warning message if the regular expression is not matched.abstract java.lang.Object
resolveValue(EnforcerRuleHelper helper)
Resolves the property valuevoid
setRegex(java.lang.String regex)
Set the property value to a given regular expression.void
setRegexMessage(java.lang.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
-
-
-
-
Method Detail
-
setRegex
public final void setRegex(java.lang.String regex)
Set the property value to a given regular expression. Defaults tonull
(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 tonull
(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(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
public abstract java.lang.String getName()
How the property that is being evaluated is called
-
getPropertyName
public abstract java.lang.String getPropertyName()
The name of the property currently being evaluated, this is used for default message pourpouses only
-
resolveValue
public abstract java.lang.Object resolveValue(EnforcerRuleHelper helper) throws EnforcerRuleException
Resolves the property value- Parameters:
helper
-- Throws:
EnforcerRuleException
-
-