Package org.apache.maven.plugins.enforcer

Class EvaluateBeanshell

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.EvaluateBeanshell

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class EvaluateBeanshell
extends AbstractNonCacheableEnforcerRule

Rule for Maven Enforcer using Beanshell to evaluate a conditional expression.

Field Summary

Fields

Modifier and Type	Field	Description
private static bsh.Interpreter	BSH	Beanshell interpreter.
private java.lang.String	condition	The condition to be evaluated.

Constructor Summary

Constructors

Constructor	Description
EvaluateBeanshell()

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluateCondition(java.lang.String script, org.apache.maven.plugin.logging.Log log)	Evaluate expression using Beanshell.
void	execute(EnforcerRuleHelper helper)	This is the interface into the rule.
java.lang.String	getCondition()
void	setCondition(java.lang.String condition)

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

BSH

private static final bsh.Interpreter BSH

Beanshell interpreter.

condition

private java.lang.String condition

The condition to be evaluated.

Constructor Detail

EvaluateBeanshell

public EvaluateBeanshell()

Method Detail

setCondition

public final void setCondition(java.lang.String condition)

getCondition

public final java.lang.String getCondition()

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

Description copied from interface: EnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag if it should stop or just log the message as a warning.

Parameters:

helper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.

Throws:

EnforcerRuleException - the enforcer rule exception

evaluateCondition

protected boolean evaluateCondition(java.lang.String script,
                                    org.apache.maven.plugin.logging.Log log)
                             throws EnforcerRuleException

Evaluate expression using Beanshell.

Parameters:

script - the expression to be evaluated

log - the logger

Returns:

boolean the evaluation of the expression

Throws:

EnforcerRuleException - if the script could not be evaluated