org.apache.maven.plugins.enforcer

Class RequireEnvironmentVariable

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

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireEnvironmentVariable
extends AbstractPropertyEnforcerRule

This rule checks that certain environment variable is set.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RequireEnvironmentVariable()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCacheId() If the rule is to be cached, this id is used as part of the key.
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
java.lang.String	getVariableName()
boolean	isCacheable() This method tells the enforcer if the rule results may be cached.
boolean	isResultValid(EnforcerRule cachedRule) Checks if cached result is valid.
java.lang.String	resolveValue(EnforcerRuleHelper helper) Resolves the property value
void	setVariableName(java.lang.String variableName)

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

execute, getRegex, getRegexMessage, setRegex, setRegexMessage

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

variableName

private java.lang.String variableName

Specify the required variable.

Constructor Detail

RequireEnvironmentVariable

public RequireEnvironmentVariable()

Method Detail

setVariableName

public final void setVariableName(java.lang.String variableName)

Parameters:

variableName - the variable name

See Also:

setVariableName(String), getVariableName()

getVariableName

public final java.lang.String getVariableName()

resolveValue

public java.lang.String resolveValue(EnforcerRuleHelper helper)

Description copied from class: AbstractPropertyEnforcerRule

Resolves the property value

Specified by:

resolveValue in class AbstractPropertyEnforcerRule

isCacheable

public boolean isCacheable()

Description copied from interface: EnforcerRule

This method tells the enforcer if the rule results may be cached. If the result is true, the results will be remembered for future executions in the same build (ie children). Subsequent iterations of the rule will be queried to see if they are also cacheable. This will allow the rule to be uncached further down the tree if needed.

Specified by:

isCacheable in interface EnforcerRule

Overrides:

isCacheable in class AbstractNonCacheableEnforcerRule

Returns:

true if rule is cacheable

isResultValid

public boolean isResultValid(EnforcerRule cachedRule)

Description copied from interface: EnforcerRule

Checks if cached result is valid.

Specified by:

isResultValid in interface EnforcerRule

Overrides:

isResultValid in class AbstractNonCacheableEnforcerRule

Parameters:

cachedRule - the last cached instance of the rule. This is to be used by the rule to potentially determine if the results are still valid (ie if the configuration has been overridden)

Returns:

true if the stored results are valid for the same id.

getCacheId

public java.lang.String getCacheId()

Description copied from interface: EnforcerRule

If the rule is to be cached, this id is used as part of the key. This can allow rules to take parameters that allow multiple results of the same rule to be cached.

Specified by:

getCacheId in interface EnforcerRule

Overrides:

getCacheId in class AbstractNonCacheableEnforcerRule

Returns:

id to be used by the enforcer to determine uniqueness of cache results. The ids only need to be unique within a given rule implementation as the full key will be [classname]-[id]

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