org.specrunner.plugins
Interface IPlugin

All Superinterfaces:

IActionType, IParameterHolder

All Known Subinterfaces:

IParalelPlugin, IPluginGroup, ISleepPlugin, ITestPlugin, ITimedPlugin, IWaitPlugin

All Known Implementing Classes:

AbstractPlugin, AbstractPluginDefine, AbstractPluginDual, AbstractPluginNamed, AbstractPluginObject, AbstractPluginObjectCompare, AbstractPluginObjectSelect, AbstractPluginObjectSelectNone, AbstractPluginObjectSelectUnique, AbstractPluginResource, AbstractPluginResourceReplaceable, AbstractPluginResourceReplaceableSrc, AbstractPluginScoped, AbstractPluginTable, AbstractPluginValue, PluginAssertion, PluginBean, PluginCall, PluginColumn, PluginCompareTree, PluginContains, PluginDefineCondition, PluginDefineGlobal, PluginDefineLocal, PluginDelete, PluginElse, PluginEquals, PluginExecute, PluginExecuteLatter, PluginExecuteRows, PluginFor, PluginGroupImpl, PluginHtml, PluginIf, PluginIfBranch, PluginImg, PluginImport, PluginInclude, PluginInsert, PluginIterable, PluginIterator, PluginLink, PluginMacro, PluginMap, PluginNop, PluginNotContains, PluginNotEquals, PluginPause, PluginReplacer, PluginReplacerMap, PluginScript, PluginSentence, PluginThen, PluginVerifyRows, PluginWhile

public interface IPlugin
extends IParameterHolder, IActionType

Generic plugin definition, stand for the action element of the framework.

Author:

Thiago Santos

Method Summary

IPlugin	copy(IContext context) Creates a copy of this plugin.
void	doEnd(IContext context, IResultSet result) The end action. i.e. after a loop specification perform something in a newly generated table.
ENext	doStart(IContext context, IResultSet result) Performs the start action. i.e. create a database schema.
IPluginFactory	getParent() Get the plugin factory source.
void	initialize(IContext context) Initialize the plugin.
void	setParent(IPluginFactory factory) Set the plugin factory (where it came from).

Methods inherited from interface org.specrunner.parameters.IParameterHolder

getParameters, setParameters

Methods inherited from interface org.specrunner.plugins.IActionType

getActionType

Method Detail

getParent

IPluginFactory getParent()

Get the plugin factory source.

Returns:

The plugin.

setParent

void setParent(IPluginFactory factory)

Set the plugin factory (where it came from).

Parameters:

factory - The factory.

initialize

void initialize(IContext context)
                throws PluginException

Initialize the plugin. Performed after set parameters.

Parameters:

context - The test context.

Throws:

PluginException - On initialization errors.

doStart

ENext doStart(IContext context,
              IResultSet result)
              throws PluginException

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

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.

doEnd

void doEnd(IContext context,
           IResultSet result)
           throws PluginException

The end action. i.e. after a loop specification perform something in a newly generated table. Performed after doStart().

Parameters:

context - The context.

result - The result set.

Throws:

PluginException - On execution errors.

copy

IPlugin copy(IContext context)
             throws PluginException

Creates a copy of this plugin.

Parameters:

context - The context.

Returns:

A copy.

Throws:

PluginException - On copy errors.