Package com.consol.citrus.docs

Class HtmlTestDocsGenerator

java.lang.Object

com.consol.citrus.docs.AbstractTestDocsGenerator

com.consol.citrus.docs.HtmlTestDocsGenerator

All Implemented Interfaces:

TestDocsGenerator

public class HtmlTestDocsGenerator
extends AbstractTestDocsGenerator

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

Since:

2007

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor	Description
HtmlTestDocsGenerator()	Default constructor with test doc template name.

Method Summary

Modifier and Type	Method	Description
static HtmlTestDocsGenerator	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)
HtmlTestDocsGenerator	useSrcDirectory(String testDir)	Adds a custom test source directory.
HtmlTestDocsGenerator	withColumns(String columns)	Adds a column configuration.
HtmlTestDocsGenerator	withLogo(String logoFilePath)	Adds a custom logo file path.
HtmlTestDocsGenerator	withOutputFile(String filename)	Adds a custom output file.
HtmlTestDocsGenerator	withOverviewTitle(String overvieTitle)	Adds a custom overview title.
HtmlTestDocsGenerator	withPageTitle(String pageTitle)	Adds a custom page title.

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

generateDoc, getSrcDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlTestDocsGenerator

public HtmlTestDocsGenerator()

Default constructor with test doc template name.

Method Detail

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

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

build

public static HtmlTestDocsGenerator build()

Builds a new test doc generator.

Returns:

withOutputFile

public HtmlTestDocsGenerator withOutputFile(String filename)

Adds a custom output file.

Parameters:

filename - the output file name.

Returns:

withPageTitle

public HtmlTestDocsGenerator withPageTitle(String pageTitle)

Adds a custom page title.

Parameters:

pageTitle - the page title.

Returns:

withOverviewTitle

public HtmlTestDocsGenerator withOverviewTitle(String overvieTitle)

Adds a custom overview title.

Parameters:

overvieTitle - the title.

Returns:

withColumns

public HtmlTestDocsGenerator withColumns(String columns)

Adds a column configuration.

Parameters:

columns - the column names.

Returns:

withLogo

public HtmlTestDocsGenerator withLogo(String logoFilePath)

Adds a custom logo file path.

Parameters:

logoFilePath - the file path.

Returns:

useSrcDirectory

public HtmlTestDocsGenerator 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: AbstractTestDocsGenerator

Gets the test doc properties.

Specified by:

getTestDocProperties in class AbstractTestDocsGenerator

Returns:

setPageTitle

public void setPageTitle(String pageTitle)

Parameters:

pageTitle - the pageTitle to set

getPageTitle

public String getPageTitle()

Returns:

the pageTitle