org.specrunner.plugins.core

Class AbstractPluginValue

java.lang.Object

org.specrunner.parameters.core.ParameterHolder

org.specrunner.plugins.core.AbstractPlugin

org.specrunner.plugins.core.AbstractPluginNamed

org.specrunner.plugins.core.AbstractPluginScoped

org.specrunner.plugins.core.AbstractPluginValue

All Implemented Interfaces:

IParameterHolder, IActionType, IParalelPlugin, IPlugin, ISleepPlugin, ITestPlugin, ITimedPlugin, IWaitPlugin

Direct Known Subclasses:

AbstractPluginDual, PluginIf, PluginImport, PluginWhile

public abstract class AbstractPluginValue
extends AbstractPluginScoped

Stand for a plugin with a value attribute, or a value which must be calculate by evaluating the content of the specification.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	eval true, of value must be evaluated as expressions, false, otherwise.
protected Object	value Plugin value.

Fields inherited from class org.specrunner.plugins.core.AbstractPluginScoped

scope

Fields inherited from class org.specrunner.plugins.core.AbstractPluginNamed

name

Fields inherited from class org.specrunner.plugins.core.AbstractPlugin

FEATURE_CONDITION, FEATURE_NORMALIZED, FEATURE_NORMALIZER, FEATURE_SLEEP, FEATURE_THREADSAFE, FEATURE_TIMEOUT, FEATURE_WAIT

Fields inherited from class org.specrunner.parameters.core.ParameterHolder

parameters

Constructor Summary

Constructors

Constructor and Description
AbstractPluginValue()

Method Summary

Methods

Modifier and Type	Method and Description
Object	getValue() Get the value attribute.
protected Object	getValue(Object str, boolean evaluate, IContext context) Gets a value based on a string.
boolean	isEval() Says if the content must be evaluated as an expression.
void	setEval(boolean eval) Sets evaluation.
void	setValue(Object value) Sets the value.

Methods inherited from class org.specrunner.plugins.core.AbstractPluginScoped

getScope, saveGlobal, saveLocal, saveStrict, setScope

Methods inherited from class org.specrunner.plugins.core.AbstractPluginNamed

getName, setName

Methods inherited from class org.specrunner.plugins.core.AbstractPlugin

copy, doEnd, doStart, getCondition, getConditionModel, getNormalized, getNormalized, getNormalizer, getParent, getSleep, getSleepModel, getThreadsafe, getTimeout, getTimeoutModel, getWait, getWaitModel, initialize, setCondition, setConditionModel, setNormalized, setNormalizer, setParent, setSleep, setSleepModel, setThreadsafe, setTimeout, setTimeoutModel, setWait, setWaitModel, toString

Methods inherited from class org.specrunner.parameters.core.ParameterHolder

getParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.specrunner.parameters.IParameterHolder

getParameters, setParameters

Methods inherited from interface org.specrunner.plugins.IActionType

getActionType

Field Detail

eval

protected boolean eval

true, of value must be evaluated as expressions, false, otherwise.

value

protected Object value

Plugin value.

Constructor Detail

AbstractPluginValue

public AbstractPluginValue()

Method Detail

isEval

public boolean isEval()

Says if the content must be evaluated as an expression.

Returns:

true, if evaluate is enable, false, otherwise. Default is false.

setEval

public void setEval(boolean eval)

Sets evaluation.

Parameters:

eval - true, to enable evaluation, false, otherwise.

getValue

public Object getValue()

Get the value attribute.

Returns:

The value.

setValue

public void setValue(Object value)

Sets the value.

Parameters:

value - A new value.

getValue

protected Object getValue(Object str,
              boolean evaluate,
              IContext context)
                   throws PluginException

Gets a value based on a string. If the plugin attribute value is set use the 'value' attribute, otherwise use the given string.

Parameters:

str - The string to be used, in case of value attribute not set.

evaluate - true, if evaluate as expression is required, false, otherwise.

context - The context.

Returns:

The object result of the evaluation.

Throws:

PluginException - On case of evaluation error.