Package com.consol.citrus.docs

Class AbstractTestDocsGenerator

java.lang.Object

com.consol.citrus.docs.AbstractTestDocsGenerator

All Implemented Interfaces:

TestDocsGenerator

Direct Known Subclasses:

ExcelTestDocsGenerator, HtmlTestDocsGenerator, SvgTestDocsGenerator

public abstract class AbstractTestDocsGenerator
extends Object
implements TestDocsGenerator

Method Summary

Modifier and Type	Method	Description
abstract void	doBody(OutputStream buffered)	Generates the test documentation.
abstract void	doHeader(OutputStream buffered)	Generates the test documentation.
void	generateDoc()	Generates the test documentation.
String	getSrcDirectory()
protected abstract Properties	getTestDocProperties()	Gets the test doc properties.

Methods inherited from class java.lang.Object

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

Method Detail

generateDoc

public void generateDoc()

Generates the test documentation.

Specified by:

generateDoc in interface TestDocsGenerator

doBody

public abstract void doBody(OutputStream buffered)
                     throws TransformerException,
                            IOException,
                            SAXException

Generates the test documentation.

Throws:

TransformerException

IOException

SAXException

doHeader

public abstract void doHeader(OutputStream buffered)
                       throws TransformerException,
                              IOException,
                              SAXException

Generates the test documentation.

Throws:

TransformerException

IOException

SAXException

getTestDocProperties

protected abstract Properties getTestDocProperties()

Gets the test doc properties.

Returns:

getSrcDirectory

public String getSrcDirectory()

Returns:

the srcDirectory