Package org.apache.maven.enforcer.rules.property

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

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 called
protected abstract java.lang.String	getPropertyName()	The name of the property currently being evaluated, this is used for default message purposes 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.
protected abstract java.lang.Object	resolveValue()	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.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

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).

regexMessage

private java.lang.String regexMessage

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

Constructor Detail

AbstractPropertyEnforcerRule

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()
             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 class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - 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