Class 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 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)
      • 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