com.consol.citrus.doc

Class HtmlTestDocGenerator

java.lang.Object

com.consol.citrus.doc.AbstractTestDocGenerator

com.consol.citrus.doc.HtmlTestDocGenerator

All Implemented Interfaces:

TestDocGenerator

public class HtmlTestDocGenerator
extends AbstractTestDocGenerator

Class to automatically generate a list of all available tests in HTML.

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
HtmlTestDocGenerator() Default constructor with test doc template name.

Method Summary

Modifier and Type	Method and Description
static HtmlTestDocGenerator	build() Builds a new test doc generator.
void	doBody(OutputStream buffered) Generates the test documentation.
void	doHeader(OutputStream buffered) Generates the test documentation.
String	getPageTitle()
protected Properties	getTestDocProperties() Gets the test doc properties.
static void	main(String[] args) Executable application cli.
void	setPageTitle(String pageTitle)
HtmlTestDocGenerator	useSrcDirectory(String testDir) Adds a custom test source directory.
HtmlTestDocGenerator	withColumns(String columns) Adds a column configuration.
HtmlTestDocGenerator	withLogo(String logoFilePath) Adds a custom logo file path.
HtmlTestDocGenerator	withOutputFile(String filename) Adds a custom output file.
HtmlTestDocGenerator	withOverviewTitle(String overvieTitle) Adds a custom overview title.
HtmlTestDocGenerator	withPageTitle(String pageTitle) Adds a custom page title.

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

generateDoc, 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

HtmlTestDocGenerator

public HtmlTestDocGenerator()

Default constructor with test doc template name.

Method Detail

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

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

build

public static HtmlTestDocGenerator build()

Builds a new test doc generator.

Returns:

withOutputFile

public HtmlTestDocGenerator withOutputFile(String filename)

Adds a custom output file.

Parameters:

filename - the output file name.

Returns:

withPageTitle

public HtmlTestDocGenerator withPageTitle(String pageTitle)

Adds a custom page title.

Parameters:

pageTitle - the page title.

Returns:

withOverviewTitle

public HtmlTestDocGenerator withOverviewTitle(String overvieTitle)

Adds a custom overview title.

Parameters:

overvieTitle - the title.

Returns:

withColumns

public HtmlTestDocGenerator withColumns(String columns)

Adds a column configuration.

Parameters:

columns - the column names.

Returns:

withLogo

public HtmlTestDocGenerator withLogo(String logoFilePath)

Adds a custom logo file path.

Parameters:

logoFilePath - the file path.

Returns:

useSrcDirectory

public HtmlTestDocGenerator useSrcDirectory(String testDir)

Adds a custom test source directory.

Parameters:

testDir - the test source directory.

Returns:

main

public static void main(String[] args)

Executable application cli.

Parameters:

args -

getTestDocProperties

protected Properties getTestDocProperties()

Description copied from class: AbstractTestDocGenerator

Gets the test doc properties.

Specified by:

getTestDocProperties in class AbstractTestDocGenerator

Returns:

setPageTitle

public void setPageTitle(String pageTitle)

Parameters:

pageTitle - the pageTitle to set

getPageTitle

public String getPageTitle()

Returns:

the pageTitle