Package org.concordion

Class Concordion

java.lang.Object

org.concordion.Concordion

public class Concordion
extends Object

Constructor Summary

Constructors

Constructor	Description
Concordion(List<SpecificationType> specificationTypes, SpecificationLocator specificationLocator, SpecificationReader specificationReader, EvaluatorFactory evaluatorFactory, FixtureDeclarations fixtureDeclarations)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	checkValidStatus(FixtureDeclarations fixtureDeclarations)
void	finish()
List<String>	getExampleNames(FixtureDeclarations fixtureDeclarations)
String	getSpecificationDescription()
boolean	hasExampleCommands()
void	override(Resource resource)	For TestRig use only
ResultSummary	process(Fixture fixture)
ResultSummary	processExample(Fixture fixture, String example)

Methods inherited from class java.lang.Object

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

Constructor Details

Concordion

public Concordion(List<SpecificationType> specificationTypes,
 SpecificationLocator specificationLocator,
 SpecificationReader specificationReader,
 EvaluatorFactory evaluatorFactory,
 FixtureDeclarations fixtureDeclarations)
           throws IOException

Constructor. Locates the specification with a type from the specificationTypes list. Errors if unable to find exactly one specification of all the specified types.

Parameters:

specificationTypes - a list of types that this Concordion instance will check for (eg. html, md), with a converter for each type

specificationLocator - locates the specification based on the specification type

specificationReader - specification reader

evaluatorFactory - evaluator factory

fixtureDeclarations - a wrapper around the fixture class

Throws:

IOException - on i/o error

Method Details

override

public void override(Resource resource)
              throws IOException

For TestRig use only

Parameters:

resource - test resource to override the specification resource with

Throws:

IOException - on i/o error

process

public ResultSummary process(Fixture fixture)
                      throws IOException

Throws:

IOException

getExampleNames

public List<String> getExampleNames(FixtureDeclarations fixtureDeclarations)
                             throws IOException

Throws:

IOException

hasExampleCommands

public boolean hasExampleCommands()
                           throws IOException

Throws:

IOException

processExample

public ResultSummary processExample(Fixture fixture,
 String example)
                             throws IOException

Throws:

IOException

finish

public void finish()

checkValidStatus

public void checkValidStatus(FixtureDeclarations fixtureDeclarations)
                      throws IOException

Throws:

IOException

getSpecificationDescription

public String getSpecificationDescription()