Package org.concordion.api

Interface SpecificationByExample

All Superinterfaces:

Specification

All Known Implementing Classes:

SpecificationToSpecificationByExampleAdaptor, XMLSpecification

public interface SpecificationByExample
extends Specification

Extension interface for Specifications that contain Concordion examples.

Since:

2.0.0

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".
List<String>	getExampleNames()	Gets all the examples in the specification.
boolean	hasExampleCommandNodes()	Returns whether the specification contains example nodes.
void	processExample(Evaluator evaluator, String example, ResultRecorder resultRecorder, Fixture fixture)	Processes a single example.

Methods inherited from interface org.concordion.api.Specification

getDescription, process

Method Details

hasExampleCommandNodes

boolean hasExampleCommandNodes()

Returns whether the specification contains example nodes.

Returns:

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

getExampleNames

List<String> getExampleNames()

Gets all the examples in the specification.

Returns:

names of the examples

processExample

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

Processes a single example.

Parameters:

evaluator - evaluator

example - name of the example

resultRecorder - result recorder

fixture - the example's fixture

finish

void finish()

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