Package org.concordion.internal

Class XMLSpecification

java.lang.Object

org.concordion.internal.XMLSpecification

All Implemented Interfaces:

Specification, SpecificationByExample

public class XMLSpecification
extends Object
implements SpecificationByExample

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OUTER_EXAMPLE_NAME
static final String	OUTER_EXAMPLE_SUFFIX

Constructor Summary

Constructors

Constructor	Description
XMLSpecification(CommandCall rootCommandNode, List<ExampleCommandCall> examples, List<CommandCall> beforeExamples)

Method Summary

Modifier and Type	Method	Description
void	finish()	Called once all examples have been executed so the spec can do things like "save HTML results to file".
String	getDescription()	Gets the description of the exported specification.
List<String>	getExampleNames()	Gets all the examples in the specification.
boolean	hasExampleCommandNodes()	Returns whether the specification contains example nodes.
void	process(Evaluator evaluator, ResultRecorder resultRecorder, Fixture fixture)
void	processExample(Evaluator evaluator, String example, ResultRecorder resultRecorder, Fixture fixture)	Processes a single example.
void	processNode(CommandCall node, Evaluator evaluator, ResultRecorder resultRecorder, Fixture fixture)

Methods inherited from class java.lang.Object

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

Field Details

OUTER_EXAMPLE_NAME

public static final String OUTER_EXAMPLE_NAME

See Also:

• Constant Field Values

OUTER_EXAMPLE_SUFFIX

public static final String OUTER_EXAMPLE_SUFFIX

See Also:

• Constant Field Values

Constructor Details

XMLSpecification

public XMLSpecification(CommandCall rootCommandNode,
 List<ExampleCommandCall> examples,
 List<CommandCall> beforeExamples)

Method Details

processNode

public void processNode(CommandCall node,
 Evaluator evaluator,
 ResultRecorder resultRecorder,
 Fixture fixture)

process

public void process(Evaluator evaluator,
 ResultRecorder resultRecorder,
 Fixture fixture)

Specified by:

process in interface Specification

processExample

public void processExample(Evaluator evaluator,
 String example,
 ResultRecorder resultRecorder,
 Fixture fixture)

Description copied from interface: SpecificationByExample

Processes a single example.

Specified by:

processExample in interface SpecificationByExample

Parameters:

evaluator - evaluator

example - name of the example

resultRecorder - result recorder

fixture - the example's fixture

hasExampleCommandNodes

public boolean hasExampleCommandNodes()

Description copied from interface: SpecificationByExample

Returns whether the specification contains example nodes.

Specified by:

hasExampleCommandNodes in interface SpecificationByExample

Returns:

true if specification has one or more nodes with an example command on

getDescription

public String getDescription()

Description copied from interface: Specification

Gets the description of the exported specification.

Specified by:

getDescription in interface Specification

Returns:

specification description

getExampleNames

public List<String> getExampleNames()

Description copied from interface: SpecificationByExample

Gets all the examples in the specification.

Specified by:

getExampleNames in interface SpecificationByExample

Returns:

names of the examples

finish

public void finish()

Description copied from interface: SpecificationByExample

Called once all examples have been executed so the spec can do things like "save HTML results to file".

Specified by:

finish in interface SpecificationByExample