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.

Author:

Marvin Froeder

Constructor Summary

Constructors

Constructor and Description
RequireEnvironmentVariable()

Method Summary

Modifier and Type	Method and Description
String	getCacheId()
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 purposes only
String	getVariableName()
boolean	isCacheable()
boolean	isResultValid(EnforcerRule cachedRule)
String	resolveValue(EnforcerRuleHelper helper) Resolves the property value
void	setVariableName(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

Constructor Detail

RequireEnvironmentVariable

public RequireEnvironmentVariable()

Method Detail

setVariableName

public final void setVariableName(String variableName)

Parameters:

variableName - the variable name

See Also:

setVariableName(String), getVariableName()

getVariableName

public final String getVariableName()

resolveValue

public String resolveValue(EnforcerRuleHelper helper)

Description copied from class: AbstractPropertyEnforcerRule

Resolves the property value

Specified by:

resolveValue in class AbstractPropertyEnforcerRule

isCacheable

public boolean isCacheable()

Specified by:

isCacheable in interface EnforcerRule

Overrides:

isCacheable in class AbstractNonCacheableEnforcerRule

isResultValid

public boolean isResultValid(EnforcerRule cachedRule)

Specified by:

isResultValid in interface EnforcerRule

Overrides:

isResultValid in class AbstractNonCacheableEnforcerRule

getCacheId

public String getCacheId()

Specified by:

getCacheId in interface EnforcerRule

Overrides:

getCacheId in class AbstractNonCacheableEnforcerRule

getPropertyName

public String getPropertyName()

Description copied from class: AbstractPropertyEnforcerRule

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

Specified by:

getPropertyName in class AbstractPropertyEnforcerRule

Returns:

the name of the property

getName

public String getName()

Description copied from class: AbstractPropertyEnforcerRule

How the property that is being evaluated is called

Specified by:

getName in class AbstractPropertyEnforcerRule

Returns:

kind of property