org.specrunner.plugins.core.text
Class PluginReplacerMap

java.lang.Object
  org.specrunner.parameters.core.ParameterHolder
      org.specrunner.plugins.core.AbstractPlugin
          org.specrunner.plugins.core.text.PluginReplacerMap

All Implemented Interfaces:

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

public class PluginReplacerMap
extends AbstractPlugin

Replace mapped elements.

Author:

Thiago Santos

See Also:

PluginIterator

Field Summary

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

FEATURE_CONDITION, FEATURE_NORMALIZED, FEATURE_SLEEP, FEATURE_THREADSAFE, FEATURE_TIMEOUT, FEATURE_WAIT

Constructor Summary

PluginReplacerMap()

Method Summary

ENext	doStart(IContext context, IResultSet result) Performs the start action. i.e. create a database schema.
ActionType	getActionType() Get the plugin type.
nu.xom.Nodes	replaceMap(String text, Map<String,nu.xom.Node> map) Replaces text with corresponding values in map.

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

copy, doEnd, getCondition, getConditionModel, getNormalized, getNormalized, getParent, getSleep, getSleepModel, getThreadsafe, getTimeout, getTimeoutModel, getWait, getWaitModel, initialize, setCondition, setConditionModel, setNormalized, 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

Constructor Detail

PluginReplacerMap

public PluginReplacerMap()

Method Detail

getActionType

public ActionType getActionType()

Description copied from interface: IActionType

Get the plugin type.

Returns:

The type.

doStart

public ENext doStart(IContext context,
                     IResultSet result)
              throws PluginException

Description copied from interface: IPlugin

Performs the start action. i.e. create a database schema. Performed after initialization.

Specified by:

doStart in interface IPlugin

Overrides:

doStart in class AbstractPlugin

Parameters:

context - The context.

result - The result set.

Returns:

SKIP, to skip node, DEEP, to go deep into the node.

Throws:

PluginException - On execution errors.

replaceMap

public nu.xom.Nodes replaceMap(String text,
                               Map<String,nu.xom.Node> map)
                        throws PluginException

Replaces text with corresponding values in map.

Parameters:

text - The text to be replace.

map - The map of values to be replace.

Returns:

The nodes which represents the replaced text.

Throws:

PluginException - On replacement errors.