Package io.github.reqstool.gradle

Class RequirementsToolExtension

java.lang.Object
io.github.reqstool.gradle.RequirementsToolExtension
public class RequirementsToolExtension extends Object
Extension for configuring the Reqstool Gradle Plugin. Provides zero-configuration defaults matching the Maven plugin behavior.

  • Constructor Details

    • RequirementsToolExtension

      public RequirementsToolExtension(org.gradle.api.Project project)
      Constructs a RequirementsToolExtension with default configuration values. Initializes all properties with sensible defaults matching Maven plugin behavior.
      Parameters:
      project - the Gradle project

  • Method Details

    • getRequirementsAnnotationsFile

      public org.gradle.api.file.RegularFileProperty getRequirementsAnnotationsFile()
      Returns the path to the requirements annotations YAML file generated by the annotation processor.
      Returns:
      file property for requirements annotations

    • getSvcsAnnotationsFiles

      public org.gradle.api.file.ConfigurableFileCollection getSvcsAnnotationsFiles()
      Returns the collection of SVCs (Software Verification Cases) annotations YAML files generated by the annotation processor for each test source set.
      Returns:
      file collection for SVCs annotations

    • setSvcsAnnotationsFiles

      public void setSvcsAnnotationsFiles(Object... paths)
      Replaces the auto-discovered SVCs annotations file collection with explicit paths and disables auto-wired compile task dependencies.
      Parameters:
      paths - one or more file paths, File, or FileCollection entries

    • isSvcsAnnotationsFilesExplicit

      public boolean isSvcsAnnotationsFilesExplicit()
      Returns whether getSvcsAnnotationsFiles() was explicitly configured.
      Returns:
      true if the user called setSvcsAnnotationsFiles(java.lang.Object...)

    • setSvcsAnnotationsFile

      @Deprecated public void setSvcsAnnotationsFile(Object file)
      Deprecated.
      Use getSvcsAnnotationsFiles() instead.
      Parameters:
      file - the file to add to getSvcsAnnotationsFiles()

    • getOutputDirectory

      public org.gradle.api.file.RegularFileProperty getOutputDirectory()
      Returns the output directory where the ZIP artifact and combined annotations are written.
      Returns:
      file property for the output directory

    • getDatasetPath

      public org.gradle.api.file.RegularFileProperty getDatasetPath()
      Returns the dataset directory containing requirements.yml and optional supporting files.
      Returns:
      file property for the dataset directory

    • getTestResults

      public org.gradle.api.provider.ListProperty<String> getTestResults()
      Returns the list of Ant-style glob patterns used to locate test result XML files.
      Returns:
      list property of test result patterns

    • getSkip

      public org.gradle.api.provider.Property<Boolean> getSkip()
      Returns whether the entire plugin execution should be skipped.
      Returns:
      boolean property; true skips all plugin tasks

    • getSkipAssembleZipArtifact

      public org.gradle.api.provider.Property<Boolean> getSkipAssembleZipArtifact()
      Returns whether ZIP artifact assembly should be skipped while still combining annotations.
      Returns:
      boolean property; true skips ZIP assembly

    • getSkipAttachZipArtifact

      public org.gradle.api.provider.Property<Boolean> getSkipAttachZipArtifact()
      Returns whether attaching the ZIP artifact for Maven publishing should be skipped.
      Returns:
      boolean property; true skips artifact attachment