Class RequireProperty
- 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
-
- org.apache.maven.enforcer.rules.property.RequireProperty
-
- All Implemented Interfaces:
EnforcerRuleBase
@Named("requireProperty") public final class RequireProperty extends AbstractPropertyEnforcerRule
This rule checks that certain properties are set.
-
-
Field Summary
Fields Modifier and Type Field Description private ExpressionEvaluator
evaluator
private java.lang.String
property
Specify the required property.
-
Constructor Summary
Constructors Constructor Description RequireProperty(ExpressionEvaluator evaluator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
How the property that is being evaluated is calledjava.lang.String
getPropertyName()
The name of the property currently being evaluated, this is used for default message purposes onlyjava.lang.Object
resolveValue()
Resolves the property valuevoid
setProperty(java.lang.String property)
java.lang.String
toString()
-
Methods inherited from class org.apache.maven.enforcer.rules.property.AbstractPropertyEnforcerRule
execute, getRegex, getRegexMessage, setRegex, setRegexMessage
-
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, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
Field Detail
-
property
private java.lang.String property
Specify the required property.
-
evaluator
private final ExpressionEvaluator evaluator
-
-
Constructor Detail
-
RequireProperty
@Inject public RequireProperty(ExpressionEvaluator evaluator)
-
-
Method Detail
-
setProperty
public void setProperty(java.lang.String property)
-
resolveValue
public java.lang.Object resolveValue() throws EnforcerRuleException
Description copied from class:AbstractPropertyEnforcerRule
Resolves the property value- Specified by:
resolveValue
in classAbstractPropertyEnforcerRule
- Returns:
- a resolve value
- Throws:
EnforcerRuleException
- in case of problems
-
getPropertyName
public java.lang.String getPropertyName()
Description copied from class:AbstractPropertyEnforcerRule
The name of the property currently being evaluated, this is used for default message purposes only- Specified by:
getPropertyName
in classAbstractPropertyEnforcerRule
- Returns:
- the name of the property
-
getName
public java.lang.String getName()
Description copied from class:AbstractPropertyEnforcerRule
How the property that is being evaluated is called- Specified by:
getName
in classAbstractPropertyEnforcerRule
- Returns:
- kind of property
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-