com.consol.citrus.doc

Class AbstractTestDocGenerator

java.lang.Object

com.consol.citrus.doc.AbstractTestDocGenerator

All Implemented Interfaces:

TestDocGenerator

Direct Known Subclasses:

ExcelTestDocGenerator, HtmlTestDocGenerator, SvgTestDocGenerator

public abstract class AbstractTestDocGenerator
extends Object
implements TestDocGenerator

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log Logger
protected String	outputFile
protected String	srcDirectory
protected String	testDocTemplate

Constructor Summary

Constructors

Constructor and Description
AbstractTestDocGenerator(String outputFile, String testDocTemplate) Default constructor using template name.

Method Summary

Modifier and Type	Method and Description
abstract void	doBody(OutputStream buffered) Generates the test documentation.
abstract void	doHeader(OutputStream buffered) Generates the test documentation.
void	generateDoc() Generates the test documentation.
protected DocumentBuilder	getDocumentBuilder() Gets a document builder instance properly configured.
protected FileOutputStream	getFileOutputStream(String fileName) Creates a output file out put stream with given file name.
static String	getOutputDirectory() Gets the outputDirectory.
String	getOutputFile()
String	getSrcDirectory()
protected abstract Properties	getTestDocProperties() Gets the test doc properties.
protected List<File>	getTestFiles() Gets all test files from test directory.
protected Transformer	getTransformer(String fileName, String mediaType, String method) Gets a transformer with proper configuration.
void	setOutputFile(String outputFile)
void	setSrcDirectory(String srcDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.slf4j.Logger log

Logger

srcDirectory

protected String srcDirectory

testDocTemplate

protected String testDocTemplate

outputFile

protected String outputFile

Constructor Detail

AbstractTestDocGenerator

public AbstractTestDocGenerator(String outputFile,
                                String testDocTemplate)

Default constructor using template name.

Method Detail

generateDoc

public void generateDoc()

Generates the test documentation.

Specified by:

generateDoc in interface TestDocGenerator

getFileOutputStream

protected FileOutputStream getFileOutputStream(String fileName)
                                        throws IOException

Creates a output file out put stream with given file name.

Returns:

Throws:

IOException

doBody

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

Generates the test documentation.

Throws:

TransformerException

IOException

SAXException

doHeader

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

Generates the test documentation.

Throws:

TransformerException

IOException

SAXException

getTestDocProperties

protected abstract Properties getTestDocProperties()

Gets the test doc properties.

Returns:

getTestFiles

protected List<File> getTestFiles()
                           throws IOException

Gets all test files from test directory.

Returns:

Throws:

IOException

getDocumentBuilder

protected DocumentBuilder getDocumentBuilder()

Gets a document builder instance properly configured.

Returns:

getTransformer

protected Transformer getTransformer(String fileName,
                                     String mediaType,
                                     String method)

Gets a transformer with proper configuration.

Parameters:

fileName -

Returns:

setSrcDirectory

public void setSrcDirectory(String srcDirectory)

Parameters:

srcDirectory - the srcDirectory to set

getSrcDirectory

public String getSrcDirectory()

Returns:

the srcDirectory

setOutputFile

public void setOutputFile(String outputFile)

Parameters:

outputFile - the outputFile to set

getOutputFile

public String getOutputFile()

Returns:

the outputFile

getOutputDirectory

public static String getOutputDirectory()

Gets the outputDirectory.

Returns:

the outputDirectory