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 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 Details

    • AbstractReportConfig

      public AbstractReportConfig(String... args)

    • AbstractReportConfig

      public AbstractReportConfig()

  • Method Details

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String title)

    • getSourceDir

      public File getSourceDir()

    • setSourceDir

      public void setSourceDir(File sourceDir)

    • getTargetDir

      public File getTargetDir()

    • setTargetDir

      public void setTargetDir(File targetDir)

    • getExcludeEmptyScenarios

      public Boolean getExcludeEmptyScenarios()

    • setExcludeEmptyScenarios

      public void setExcludeEmptyScenarios(Boolean excludeEmptyScenarios)

    • getReportModel

      public CompleteReportModel getReportModel()

    • printUsageAndExit

      public void printUsageAndExit()

    • useConfigMap

      public abstract void useConfigMap(Map<String,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(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