Package com.tngtech.jgiven.report

Class AbstractReportConfig

java.lang.Object

com.tngtech.jgiven.report.AbstractReportConfig

Direct Known Subclasses:

AsciiDocReportConfig, PlainTextReportConfig

public abstract class AbstractReportConfig
extends java.lang.Object

Basic configuration for a report with an extendable interface The configMap should always be in a valid state and have all possible flags, except the optional ones without a default (like --help) For examples see AsciiDocReportConfig

Constructor Summary

Constructors

Constructor	Description
AbstractReportConfig()
AbstractReportConfig(java.lang.String... args)

Method Summary

Modifier and Type	Method	Description
abstract void	additionalConfigOptions(java.util.List<ConfigOption> configOptions)	This is used to create new ConfigOption for the AbstractReportConfig by appending them to the list
java.lang.Boolean	getExcludeEmptyScenarios()
CompleteReportModel	getReportModel()
java.io.File	getSourceDir()
java.io.File	getTargetDir()
java.lang.String	getTitle()
void	printUsageAndExit()
void	setExcludeEmptyScenarios(java.lang.Boolean excludeEmptyScenarios)
void	setSourceDir(java.io.File sourceDir)
void	setTargetDir(java.io.File targetDir)
void	setTitle(java.lang.String title)
abstract void	useConfigMap(java.util.Map<java.lang.String,java.lang.Object> configMap)	Every flag should be defined except the optional ones without a default (like --help)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReportConfig

public AbstractReportConfig(java.lang.String... args)

AbstractReportConfig

public AbstractReportConfig()

Method Detail

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getSourceDir

public java.io.File getSourceDir()

setSourceDir

public void setSourceDir(java.io.File sourceDir)

getTargetDir

public java.io.File getTargetDir()

setTargetDir

public void setTargetDir(java.io.File targetDir)

getExcludeEmptyScenarios

public java.lang.Boolean getExcludeEmptyScenarios()

setExcludeEmptyScenarios

public void setExcludeEmptyScenarios(java.lang.Boolean excludeEmptyScenarios)

getReportModel

public CompleteReportModel getReportModel()

printUsageAndExit

public void printUsageAndExit()

useConfigMap

public abstract void useConfigMap(java.util.Map<java.lang.String,java.lang.Object> configMap)

Every flag should be defined except the optional ones without a default (like --help)

Parameters:

configMap - the config map with a mapping of Strings to castable objects

additionalConfigOptions

public abstract void additionalConfigOptions(java.util.List<ConfigOption> configOptions)

This is used to create new ConfigOption for the AbstractReportConfig by appending them to the list

Parameters:

configOptions - config options list, add new options here