org.specrunner.plugins.core.include

Class PluginImport

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

org.specrunner.plugins.core.include.PluginImport

All Implemented Interfaces:

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

public class PluginImport
extends AbstractPluginValue

Add package information as SLIM import tables. Imports can also be performed simply by adding attribute 'imports' to any element.

Imports can be performed:

• in blocks, i.e.

   <.. imports="package1;package2;...;packageN"/>
   

  on every valid tag;
• in tables, i.e. In columns

            <table class="imports">
                <tr><td>package1</td><td>...</td><td>packageN</td></tr>
            </table>
   

  or in rows

            <table class="imports">
                <tr><td>package1</td></tr>
                <tr><td>...</td></tr>
                <tr><td>packageN</td></tr>
            </table>
   

• in free tags, i.e.

        <imports>package1;...;packageN<imports>
   

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
protected String	imports Set a import package names separated by ';'.
protected String[]	packages The packages set in imports.
static String	PACKAGES_NAME The import list name.

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

eval, 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
PluginImport()

Method Summary

Methods

Modifier and Type	Method and Description
ENext	doStart(IContext context, IResultSet result) Performs the start action.
ActionType	getActionType() Get the plugin type.
String	getImports() Get the list of imports.
static List<String>	getPackages(IContext context) Recover the package list in context, if any.
void	setImports(String imports) Set the list of imports.

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

getValue, getValue, isEval, setEval, setValue

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, 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

Field Detail

PACKAGES_NAME

public static final String PACKAGES_NAME

The import list name.

See Also:

Constant Field Values

imports

protected String imports

Set a import package names separated by ';'.

packages

protected String[] packages

The packages set in imports.

Constructor Detail

PluginImport

public PluginImport()

Method Detail

getActionType

public ActionType getActionType()

Description copied from interface: IActionType

Get the plugin type.

Returns:

The type.

getImports

public String getImports()

Get the list of imports.

Returns:

The import list.

setImports

public void setImports(String imports)

Set the list of imports.

Parameters:

imports - The import list separated by ';'.

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.

getPackages

public static List<String> getPackages(IContext context)

Recover the package list in context, if any. Empty list if not found.

Parameters:

context - Context.

Returns:

The package list, if exists, false, otherwise.