com.consol.citrus.doc

Class SvgTestDocGenerator

java.lang.Object

com.consol.citrus.doc.AbstractTestDocGenerator

com.consol.citrus.doc.SvgTestDocGenerator

All Implemented Interfaces:

TestDocGenerator

public final class SvgTestDocGenerator
extends AbstractTestDocGenerator

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

Since:

2007

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.doc.AbstractTestDocGenerator

log, outputFile, srcDirectory, testDocTemplate

Constructor Summary

Constructors

Constructor and Description
SvgTestDocGenerator() Default constructor.

Method Summary

Modifier and Type	Method and Description
static SvgTestDocGenerator	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.
SvgTestDocGenerator	useSrcDirectory(String testDir) Adds a custom test source directory.

Methods inherited from class com.consol.citrus.doc.AbstractTestDocGenerator

getDocumentBuilder, getFileOutputStream, getOutputDirectory, getOutputFile, getSrcDirectory, getTestFiles, getTransformer, setOutputFile, setSrcDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

SvgTestDocGenerator

public SvgTestDocGenerator()

Default constructor.

Method Detail

generateDoc

public void generateDoc()

Generates the test documentation.

Specified by:

generateDoc in interface TestDocGenerator

Overrides:

generateDoc in class AbstractTestDocGenerator

build

public static SvgTestDocGenerator build()

Builds a new test doc generator.

Returns:

useSrcDirectory

public SvgTestDocGenerator 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: AbstractTestDocGenerator

Generates the test documentation.

Specified by:

doBody in class AbstractTestDocGenerator

Throws:

TransformerException

IOException

SAXException

doHeader

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

Description copied from class: AbstractTestDocGenerator

Generates the test documentation.

Specified by:

doHeader in class AbstractTestDocGenerator

Throws:

TransformerException

IOException

SAXException

getTestDocProperties

protected Properties getTestDocProperties()

Description copied from class: AbstractTestDocGenerator

Gets the test doc properties.

Specified by:

getTestDocProperties in class AbstractTestDocGenerator

Returns: