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

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 1382374 2012-09-08 21:47:58Z olamy $

Author:

Paul Gier, Marvin Froeder

Field Summary

Fields

Modifier and Type	Field and Description
String	regex Match the property value to a given regular expression.
String	regexMessage Specify a warning message if the regular expression is not matched.

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(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
abstract Object	resolveValue(EnforcerRuleHelper helper) Resolves the property value

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class java.lang.Object

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

Field Detail

regex

public String regex

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

regexMessage

public String regexMessage

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

Constructor Detail

AbstractPropertyEnforcerRule

public AbstractPropertyEnforcerRule()

Method Detail

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

Execute the rule.

Parameters:

helper - the helper

Throws:

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(EnforcerRuleHelper helper)
                             throws EnforcerRuleException

Resolves the property value

Parameters:

helper -

Throws:

EnforcerRuleException