org.specrunner.listeners.core
Class ScenarioFrameListener

java.lang.Object
  org.specrunner.listeners.core.ScenarioFrameListener

All Implemented Interfaces:

INodeListener, ISpecRunnerListener

public class ScenarioFrameListener
extends Object
implements INodeListener

Monitor for scenarios frames.

Author:

Thiago Santos.

Field Summary

protected int	checkpoint A checkpoint where in the general result the scenario starts.
static String	CSS_SCENARIO Expected style for scenarios.
static String	CSS_SCENARIO_FAILURE Expected style for failure scenarios.
static String	CSS_SCENARIO_PENDING Expected style for pending scenarios.
static String	CSS_SCENARIO_SUCCESS Expected style for success scenarios.
static String	CSS_TITLE Expected style for scenario titles.
protected INodeHolder	holder An auxiliary node holder.
protected IScenarioListener[]	listeners Scenario listeners.
protected String	name The listener name.
protected boolean	pending Indicate if scenario is pending.
protected nu.xom.Node	scenario The node which holds the scenario.
protected IResultSet	subset The subset of general result for this scenario.

Constructor Summary

ScenarioFrameListener(String name, IScenarioListener... listeners)
Creates a names scenario listener.

Method Summary

protected void	fireAfter(String title, nu.xom.Node node, IContext context, IResultSet result) Fire listeners after scenarios.
protected void	fireBefore(String title, nu.xom.Node node, IContext context, IResultSet result) Fire listeners before scenarios.
String	getName() The listener name.
IResultSet	getResult() Get the result subset specific to this scenario.
boolean	isPending() Answer if the scenario is pending.
void	onAfter(nu.xom.Node node, IContext context, IResultSet result) Perform some action after plugin execution for a given node.
ENext	onBefore(nu.xom.Node node, IContext context, IResultSet result) Perform some action before building plugin for a given node.
void	reset() Reset listener state.

Methods inherited from class java.lang.Object

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

Field Detail

CSS_SCENARIO

public static final String CSS_SCENARIO

Expected style for scenarios.

See Also:

Constant Field Values

CSS_SCENARIO_SUCCESS

public static final String CSS_SCENARIO_SUCCESS

Expected style for success scenarios.

See Also:

Constant Field Values

CSS_SCENARIO_FAILURE

public static final String CSS_SCENARIO_FAILURE

Expected style for failure scenarios.

See Also:

Constant Field Values

CSS_SCENARIO_PENDING

public static final String CSS_SCENARIO_PENDING

Expected style for pending scenarios.

See Also:

Constant Field Values

CSS_TITLE

public static final String CSS_TITLE

Expected style for scenario titles.

See Also:

Constant Field Values

name

protected String name

The listener name.

listeners

protected IScenarioListener[] listeners

Scenario listeners.

holder

protected INodeHolder holder

An auxiliary node holder.

scenario

protected nu.xom.Node scenario

The node which holds the scenario.

checkpoint

protected int checkpoint

A checkpoint where in the general result the scenario starts.

pending

protected boolean pending

Indicate if scenario is pending.

subset

protected IResultSet subset

The subset of general result for this scenario.

Constructor Detail

ScenarioFrameListener

public ScenarioFrameListener(String name,
                             IScenarioListener... listeners)

Creates a names scenario listener. The scenario name must be the same of the corresponding scenario it is expected to monitor.

Parameters:

name - The scenario.

listeners - List of scenario listeners.

Method Detail

reset

public void reset()

Description copied from interface: ISpecRunnerListener

Reset listener state.

Specified by:

reset in interface ISpecRunnerListener

getName

public String getName()

Description copied from interface: ISpecRunnerListener

The listener name. Used to distinguish between different listeners.

Specified by:

getName in interface ISpecRunnerListener

Returns:

The listener name.

onBefore

public ENext onBefore(nu.xom.Node node,
                      IContext context,
                      IResultSet result)

Description copied from interface: INodeListener

Perform some action before building plugin for a given node.

Specified by:

onBefore in interface INodeListener

Parameters:

node - The node.

context - The context.

result - The result.

Returns:

The next step on execution. If return is ENext.DEEP, the execution should go deeper.

fireBefore

protected void fireBefore(String title,
                          nu.xom.Node node,
                          IContext context,
                          IResultSet result)

Fire listeners before scenarios.

Parameters:

title - The scenario title.

node - The scenario node.

context - The test context.

result - The result set.

onAfter

public void onAfter(nu.xom.Node node,
                    IContext context,
                    IResultSet result)

Description copied from interface: INodeListener

Perform some action after plugin execution for a given node.

Specified by:

onAfter in interface INodeListener

Parameters:

node - The node.

context - The context.

result - The result.

fireAfter

protected void fireAfter(String title,
                         nu.xom.Node node,
                         IContext context,
                         IResultSet result)

Fire listeners after scenarios.

Parameters:

title - The scenario title.

node - The scenario node.

context - The test context.

result - The result set.

isPending

public boolean isPending()

Answer if the scenario is pending.

Returns:

true, if pending, false, otherwise.

getResult

public IResultSet getResult()

Get the result subset specific to this scenario.

Returns:

The result subset.