Package com.tngtech.jgiven.report.asciidoc

Class AsciiDocReportGenerator

java.lang.Object

com.tngtech.jgiven.report.AbstractReportGenerator

com.tngtech.jgiven.report.asciidoc.AsciiDocReportGenerator

public class AsciiDocReportGenerator
extends AbstractReportGenerator

This reporter provides the functionality for reading/writing a report in AsciiDoc format.

The following flags are reused from AbstractReportConfig:

• --format=
• --sourceDir= / --dir=
• --targetDir= / --todir=
• --title=
• --exclude-empty-scenarios=<boolean>
• --help / -h

Field Summary

Fields inherited from class com.tngtech.jgiven.report.AbstractReportGenerator

completeReportModel, config

Constructor Summary

Constructors

Constructor	Description
AsciiDocReportGenerator()

Method Summary

Modifier and Type	Method	Description
AsciiDocReportConfig	createReportConfig(String... args)
void	generate()	This implements the main functionality of the report generator, utilizing the information from the specialized AbstractReportConfig

Methods inherited from class com.tngtech.jgiven.report.AbstractReportGenerator

generateFromCommandLine, generateWithConfig, loadReportModel, setConfig

Methods inherited from class java.lang.Object

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

Constructor Details

AsciiDocReportGenerator

public AsciiDocReportGenerator()

Method Details

createReportConfig

public AsciiDocReportConfig createReportConfig(String... args)

Specified by:

createReportConfig in class AbstractReportGenerator

Parameters:

args - these are the command line arguments

Returns:

an AbstractReportConfig where any option may be accessible via setter and getter

generate

public void generate()

Description copied from class: AbstractReportGenerator

This implements the main functionality of the report generator, utilizing the information from the specialized AbstractReportConfig

Specified by:

generate in class AbstractReportGenerator