Class AbstractPropertyEnforcerRule
- java.lang.Object
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
- org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
-
- org.apache.maven.enforcer.rules.property.AbstractPropertyEnforcerRule
-
- All Implemented Interfaces:
EnforcerRuleBase
- Direct Known Subclasses:
RequireEnvironmentVariable
,RequireProperty
abstract class AbstractPropertyEnforcerRule extends AbstractStandardEnforcerRule
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()
This is the interface into the rule.protected abstract java.lang.String
getName()
How the property that is being evaluated is calledprotected abstract java.lang.String
getPropertyName()
The name of the property currently being evaluated, this is used for default message purposes 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.protected abstract java.lang.Object
resolveValue()
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.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
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() 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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- 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
-
resolveValue
protected abstract java.lang.Object resolveValue() throws EnforcerRuleException
Resolves the property value- Returns:
- a resolve value
- Throws:
EnforcerRuleException
- in case of problems
-
-