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:

org.apache.maven.enforcer.rule.api.EnforcerRule

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$

Author:

Paul Gier, Marvin Froeder

Field Summary

Fields

Modifier and Type	Field and Description
String	regex Deprecated. the visibility will be reduced to private with the next major version
String	regexMessage Deprecated. the visibility will be reduced to private with the next major version

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

Constructors

Constructor and Description
AbstractPropertyEnforcerRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Execute the rule.
abstract String	getName() How the property that is being evaluated is called
abstract String	getPropertyName() The name of the property currently being evaluated, this is used for default message pourpouses only
String	getRegex() Get the property value to a given regular expression.
String	getRegexMessage() Get a warning message if the regular expression is not matched.
abstract Object	resolveValue(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Resolves the property value
void	setRegex(String regex) Set the property value to a given regular expression.
void	setRegexMessage(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

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

regex

public String regex

Deprecated. the visibility will be reduced to private with the next major version

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

See Also:

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

regexMessage

public String regexMessage

Deprecated. the visibility will be reduced to private with the next major version

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(String regex)

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

Parameters:

the - regular expression

getRegex

public final 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(String regexMessage)

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

Parameters:

regexMessage - the regex message

getRegexMessage

public final String getRegexMessage()

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

Returns:

the regex message

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Execute the rule.

Parameters:

helper - the helper

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - the enforcer rule exception

getName

public abstract String getName()

How the property that is being evaluated is called

getPropertyName

public abstract String getPropertyName()

The name of the property currently being evaluated, this is used for default message pourpouses only

resolveValue

public abstract Object resolveValue(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
                             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Resolves the property value

Parameters:

helper -

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException