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.- Version:
- $Id: AbstractPropertyEnforcerRule.java 1697215 2015-08-23 16:27:17Z khmarbaise $
- Author:
- Paul Gier, Marvin Froeder
-
-
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)
Execute the rule.abstract String
getName()
How the property that is being evaluated is calledabstract String
getPropertyName()
The name of the property currently being evaluated, this is used for default message pourpouses onlyString
getRegex()
Get the property value to a given regular expression.String
getRegexMessage()
Get a warning message if the regular expression is not matched.abstract Object
resolveValue(EnforcerRuleHelper helper)
Resolves the property valuevoid
setRegex(String regex)
Set the property value to a given regular expression.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
-
-
-
-
Method Detail
-
setRegex
public final void setRegex(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 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(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(EnforcerRuleHelper helper) throws EnforcerRuleException
Execute the rule.- Parameters:
helper
- the helper- Throws:
EnforcerRuleException
- the enforcer rule exception
-
getName
public abstract String getName()
How the property that is being evaluated is called
-
getPropertyName
public abstract String getPropertyName()
The name of the property currently being evaluated, this is used for default message pourpouses only
-
resolveValue
public abstract Object resolveValue(EnforcerRuleHelper helper) throws EnforcerRuleException
Resolves the property value- Parameters:
helper
-- Throws:
EnforcerRuleException
-
-