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:

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

public class RequireProperty
extends AbstractPropertyEnforcerRule

This rule checks that certain properties are set.

Author:

Paul Gier

Field Summary

Fields

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

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

regex, regexMessage

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

message

Constructor Summary

Constructors

Constructor and Description
RequireProperty()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() How the property that is being evaluated is called
String	getPropertyName() The name of the property currently being evaluated, this is used for default message pourpouses only
protected String	resolveValue()
Object	resolveValue(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Resolves the property value
void	setProperty(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

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

property

public String property

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

Specify the required property.

See Also:

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

Constructor Detail

RequireProperty

public RequireProperty()

Method Detail

setProperty

public final void setProperty(String property)

resolveValue

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

Description copied from class: AbstractPropertyEnforcerRule

Resolves the property value

Specified by:

resolveValue in class AbstractPropertyEnforcerRule

Throws:

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

resolveValue

protected String resolveValue()

getPropertyName

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

Description copied from class: AbstractPropertyEnforcerRule

How the property that is being evaluated is called

Specified by:

getName in class AbstractPropertyEnforcerRule