org.apache.maven.plugins.enforcer

Class RequireProperty

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

org.apache.maven.plugins.enforcer.RequireProperty

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireProperty
extends AbstractPropertyEnforcerRule

This rule checks that certain properties are set.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	property Specify the required property.

Constructor Summary

Constructors

Constructor and Description
RequireProperty()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() How the property that is being evaluated is called
java.lang.String	getPropertyName() The name of the property currently being evaluated, this is used for default message pourpouses only
protected java.lang.String	resolveValue()
java.lang.Object	resolveValue(EnforcerRuleHelper helper) Resolves the property value
void	setProperty(java.lang.String property)

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

execute, getRegex, getRegexMessage, setRegex, setRegexMessage

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

property

private java.lang.String property

Specify the required property.

See Also:

#setProperty(String)}, #getPropertyName()}

Constructor Detail

RequireProperty

public RequireProperty()

Method Detail

setProperty

public final void setProperty(java.lang.String property)

resolveValue

public java.lang.Object resolveValue(EnforcerRuleHelper helper)
                              throws EnforcerRuleException

Description copied from class: AbstractPropertyEnforcerRule

Resolves the property value

Specified by:

resolveValue in class AbstractPropertyEnforcerRule

Throws:

EnforcerRuleException

resolveValue

protected java.lang.String resolveValue()

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 pourpouses only

Specified by:

getPropertyName in class AbstractPropertyEnforcerRule

getName

public java.lang.String getName()

Description copied from class: AbstractPropertyEnforcerRule

How the property that is being evaluated is called

Specified by:

getName in class AbstractPropertyEnforcerRule