org.apache.maven.plugins.enforcer

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 $

Field Summary

Fields

Modifier and Type	Field and 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 and Description
AbstractPropertyEnforcerRule()

Method Summary

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper helper) Execute the rule.
abstract java.lang.String	getName() How the property that is being evaluated is called
abstract java.lang.String	getPropertyName() The name of the property currently being evaluated, this is used for default message pourpouses only
java.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 value
void	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

regex

private java.lang.String regex

Match the property value to a given regular expression. Defaults to null (any value is ok).

See Also:

#setRegex(String)}, #getRegex()}

regexMessage

private java.lang.String regexMessage

Specify a warning message if the regular expression is not matched.

See Also:

#setRegexMessage(String)}, #getRegexMessage()}

Constructor Detail

AbstractPropertyEnforcerRule

public AbstractPropertyEnforcerRule()

Method Detail

setRegex

public final void setRegex(java.lang.String regex)

Set the property value to a given regular expression. Defaults to null (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 to null (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

Execute the rule.

Parameters:

helper - the helper

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