Package org.tabletest.gradle

Class TableTestReporterExtension

java.lang.Object
org.tabletest.gradle.TableTestReporterExtension
public abstract class TableTestReporterExtension extends Object
Gradle extension to configure TableTest Reporter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TableTestReporterExtension(org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.provider.ProviderFactory providers)
    Creates a new extension instance with default configuration values.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.file.RegularFileProperty
    getConfigFile()
    Returns the report configuration file property.
    org.gradle.api.provider.Property<String>
    getFormat()
    Returns the output format property.
    org.gradle.api.provider.Property<String>
    getIndexDepth()
    Returns the index depth property.
    org.gradle.api.file.DirectoryProperty
    getInputDir()
    Returns the input directory property.
    org.gradle.api.file.ConfigurableFileCollection
    getInputDirs()
    Returns the input directories to merge into one report — for a multi-project build where several subprojects' TableTest output belongs in a single spec.
    org.gradle.api.file.DirectoryProperty
    getOutputDir()
    Returns the output directory property.
    org.gradle.api.file.DirectoryProperty
    getTemplateDir()
    Returns the template directory property.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TableTestReporterExtension

      @Inject public TableTestReporterExtension(org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.provider.ProviderFactory providers)
      Creates a new extension instance with default configuration values.
      Parameters:
      objects - Gradle object factory for creating properties
      layout - project layout for resolving build directory paths
      providers - provider factory for creating providers

  • Method Details

    • getFormat

      public org.gradle.api.provider.Property<String> getFormat()
      Returns the output format property.
      Returns:
      property for specifying output format (asciidoc or markdown)

    • getInputDir

      public org.gradle.api.file.DirectoryProperty getInputDir()
      Returns the input directory property.
      Returns:
      property for directory containing TableTest YAML files

    • getInputDirs

      public org.gradle.api.file.ConfigurableFileCollection getInputDirs()
      Returns the input directories to merge into one report — for a multi-project build where several subprojects' TableTest output belongs in a single spec. Overrides inputDir when set; a directory that does not exist is skipped with a warning.
      Returns:
      file collection of directories containing TableTest YAML files

    • getOutputDir

      public org.gradle.api.file.DirectoryProperty getOutputDir()
      Returns the output directory property.
      Returns:
      property for directory where generated documentation will be written

    • getTemplateDir

      public org.gradle.api.file.DirectoryProperty getTemplateDir()
      Returns the template directory property.
      Returns:
      property for optional custom template directory

    • getIndexDepth

      public org.gradle.api.provider.Property<String> getIndexDepth()
      Returns the index depth property.
      Returns:
      property for specifying how many levels to show in index files (1, 2, ..., or "infinite")

    • getConfigFile

      public org.gradle.api.file.RegularFileProperty getConfigFile()
      Returns the report configuration file property.
      Returns:
      property for the tabletest-reporter.yaml file holding spec title, intro and feature order