Class RequireEnvironmentVariable
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.property.RequireEnvironmentVariable
- All Implemented Interfaces:
EnforcerRuleBase
@Named("requireEnvironmentVariable")
public final class RequireEnvironmentVariable
extends AbstractStandardEnforcerRule
This rule checks that certain environment variable is set.
- Author:
- Marvin Froeder
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
getLog()
getName()
How the property that is being evaluated is calledThe name of the property currently being evaluated, this is used for default message purposes 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.Resolves the property valuevoid
setLog
(EnforcerLogger arg0) final 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.void
setVariableName
(String variableName) toString()
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getLevel
-
Constructor Details
-
RequireEnvironmentVariable
public RequireEnvironmentVariable()
-
-
Method Details
-
setVariableName
-
resolveValue
Resolves the property value- Returns:
- a resolve value
-
getCacheId
- Overrides:
getCacheId
in classAbstractEnforcerRule
-
getPropertyName
The name of the property currently being evaluated, this is used for default message purposes only- Returns:
- the name of the property
-
getName
How the property that is being evaluated is called- Returns:
- kind of property
-
toString
-
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
- Specified by:
execute
in classAbstractEnforcerRule
- Throws:
EnforcerRuleException
-
setLog
- Specified by:
setLog
in interfaceEnforcerRuleBase
-
getLog
-