Package com.consol.citrus.docs

Class ExcelTestDocsGenerator

java.lang.Object

com.consol.citrus.docs.AbstractTestDocsGenerator

com.consol.citrus.docs.ExcelTestDocsGenerator

All Implemented Interfaces:

TestDocsGenerator

public class ExcelTestDocsGenerator
extends AbstractTestDocsGenerator

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

Since:

2007

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor	Description
ExcelTestDocsGenerator()	Default constructor using test doc template name.

Method Summary

Modifier and Type	Method	Description
static ExcelTestDocsGenerator	build()	Builds a new test doc generator.
void	doBody(OutputStream buffered)	Generates the test documentation.
void	doHeader(OutputStream buffered)	Generates the test documentation.
String	getAuthor()
String	getCompany()
String	getPageTitle()
protected Properties	getTestDocProperties()	Gets the test doc properties.
static void	main(String[] args)	Executable application cli.
void	setAuthor(String author)
void	setCompany(String company)
void	setPageTitle(String pageTitle)
ExcelTestDocsGenerator	useSrcDirectory(String testDir)	Adds a custom test source directory.
ExcelTestDocsGenerator	withAuthor(String author)	Adds a custom author name.
ExcelTestDocsGenerator	withCompany(String company)	Adds a custom company.
ExcelTestDocsGenerator	withCustomHeaders(String customHeaders)	Adds a custom header configuration.
ExcelTestDocsGenerator	withOutputFile(String filename)	Adds a custom output file.
ExcelTestDocsGenerator	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

ExcelTestDocsGenerator

public ExcelTestDocsGenerator()

Default constructor using 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

getTestDocProperties

protected Properties getTestDocProperties()

Description copied from class: AbstractTestDocsGenerator

Gets the test doc properties.

Specified by:

getTestDocProperties in class AbstractTestDocsGenerator

Returns:

build

public static ExcelTestDocsGenerator build()

Builds a new test doc generator.

Returns:

withOutputFile

public ExcelTestDocsGenerator withOutputFile(String filename)

Adds a custom output file.

Parameters:

filename - the output file name.

Returns:

withPageTitle

public ExcelTestDocsGenerator withPageTitle(String pageTitle)

Adds a custom page title.

Parameters:

pageTitle - the page title.

Returns:

useSrcDirectory

public ExcelTestDocsGenerator useSrcDirectory(String testDir)

Adds a custom test source directory.

Parameters:

testDir - the test source directory.

Returns:

withAuthor

public ExcelTestDocsGenerator withAuthor(String author)

Adds a custom author name.

Parameters:

author - the author name.

Returns:

withCompany

public ExcelTestDocsGenerator withCompany(String company)

Adds a custom company.

Parameters:

company - the company name.

Returns:

withCustomHeaders

public ExcelTestDocsGenerator withCustomHeaders(String customHeaders)

Adds a custom header configuration.

Parameters:

customHeaders - the header configuration.

Returns:

main

public static void main(String[] args)

Executable application cli.

Parameters:

args -

setPageTitle

public void setPageTitle(String pageTitle)

Parameters:

pageTitle - the pageTitle to set

getPageTitle

public String getPageTitle()

Returns:

the pageTitle

getCompany

public String getCompany()

Returns:

the company

setCompany

public void setCompany(String company)

Parameters:

company - the company to set

getAuthor

public String getAuthor()

Returns:

the author

setAuthor

public void setAuthor(String author)

Parameters:

author - the author to set