Package com.consol.citrus.docs

Class SvgTestDocsGenerator

java.lang.Object

com.consol.citrus.docs.AbstractTestDocsGenerator

com.consol.citrus.docs.SvgTestDocsGenerator

All Implemented Interfaces:

TestDocsGenerator

public final class SvgTestDocsGenerator
extends AbstractTestDocsGenerator

Class to automatically generate a visual representation of a TestCase in SVG.

Since:

2007

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor	Description
SvgTestDocsGenerator()	Default constructor.

Method Summary

Modifier and Type	Method	Description
static SvgTestDocsGenerator	build()	Builds a new test doc generator.
void	doBody(OutputStream buffered)	Generates the test documentation.
void	doHeader(OutputStream buffered)	Generates the test documentation.
void	generateDoc()	Generates the test documentation.
protected Properties	getTestDocProperties()	Gets the test doc properties.
SvgTestDocsGenerator	useSrcDirectory(String testDir)	Adds a custom test source directory.

Methods inherited from class com.consol.citrus.docs.AbstractTestDocsGenerator

getSrcDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

SvgTestDocsGenerator

public SvgTestDocsGenerator()

Default constructor.

Method Detail

generateDoc

public void generateDoc()

Generates the test documentation.

Specified by:

generateDoc in interface TestDocsGenerator

Overrides:

generateDoc in class AbstractTestDocsGenerator

build

public static SvgTestDocsGenerator build()

Builds a new test doc generator.

Returns:

useSrcDirectory

public SvgTestDocsGenerator useSrcDirectory(String testDir)

Adds a custom test source directory.

Parameters:

testDir - the test source directory.

Returns:

doBody

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

Description copied from class: AbstractTestDocsGenerator

Generates the test documentation.

Specified by:

doBody in class AbstractTestDocsGenerator

Throws:

TransformerException

IOException

SAXException

doHeader

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

Description copied from class: AbstractTestDocsGenerator

Generates the test documentation.

Specified by:

doHeader in class AbstractTestDocsGenerator

Throws:

TransformerException

IOException

SAXException

getTestDocProperties

protected Properties getTestDocProperties()

Description copied from class: AbstractTestDocsGenerator

Gets the test doc properties.

Specified by:

getTestDocProperties in class AbstractTestDocsGenerator

Returns: