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:

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

public class RequireEnvironmentVariable
extends AbstractPropertyEnforcerRule

This rule checks that certain environment variable is set.

Author:

Marvin Froeder

Field Summary

Fields

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

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
RequireEnvironmentVariable()

Method Summary

Methods

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 pourpouses only
String	getVariableName()
boolean	isCacheable()
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule cachedRule)
String	resolveValue(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Resolves the property value
void	setVariableName(String variableName) Deprecated. the visibility will be reduced to private with the next major version

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

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

variableName

public String variableName

Specify the required variable.

Constructor Detail

RequireEnvironmentVariable

public RequireEnvironmentVariable()

Method Detail

setVariableName

public final void setVariableName(String variableName)

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

Parameters:

variableName - the variable name

See Also:

#setVariableName(String)}, #getVariableName()}

getVariableName

public final String getVariableName()

resolveValue

public String resolveValue(org.apache.maven.enforcer.rule.api.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 org.apache.maven.enforcer.rule.api.EnforcerRule

Overrides:

isCacheable in class AbstractNonCacheableEnforcerRule

isResultValid

public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule cachedRule)

Specified by:

isResultValid in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Overrides:

isResultValid in class AbstractNonCacheableEnforcerRule

getCacheId

public String getCacheId()

Specified by:

getCacheId in interface org.apache.maven.enforcer.rule.api.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 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