Package org.itsallcode.openfasttrace.gradle.config

Class TracingConfig

java.lang.Object
org.itsallcode.openfasttrace.gradle.config.TracingConfig
public class TracingConfig extends Object
Configuration of requirement collection and tracing.

  • Constructor Details

    • TracingConfig

      public TracingConfig(org.gradle.api.Project project)
      Creates a tracing configuration with the plugin defaults.
      Parameters:
      project - the Gradle project owning the configuration

  • Method Details

    • getReportVerbosity

      public org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.report.ReportVerbosity> getReportVerbosity()
      Returns the report verbosity property.
      Returns:
      the verbosity property

    • getReportColorScheme

      public org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.ColorScheme> getReportColorScheme()
      Returns the report color scheme.
      Returns:
      the color scheme

    • getReportFormat

      public org.gradle.api.provider.Property<String> getReportFormat()
      Returns the report format property.
      Returns:
      the format property

    • getInputDirectories

      public org.gradle.api.file.ConfigurableFileCollection getInputDirectories()
      Returns the directories containing requirements.
      Returns:
      the input directories

    • getReportFile

      public org.gradle.api.file.RegularFileProperty getReportFile()
      Returns the optional report output file.
      Returns:
      the report file

    • getImportedRequirements

      public org.gradle.api.provider.ListProperty<Object> getImportedRequirements()
      Returns the external requirement dependencies. This is a list of dependency coordinates pointing to ZIP files containing requirements, e.g. com.example:swad:1.0.0@zip.
      Returns:
      the imported requirements

    • getFilteredTags

      public org.gradle.api.provider.SetProperty<String> getFilteredTags()
      Returns the tags to include in tracing.
      Returns:
      the tag filter

    • getFilteredArtifactTypes

      public org.gradle.api.provider.SetProperty<String> getFilteredArtifactTypes()
      Returns the artifact types to include in tracing.
      Returns:
      the artifact type filter

    • getFilterAcceptsItemsWithoutTag

      public org.gradle.api.provider.Property<Boolean> getFilterAcceptsItemsWithoutTag()
      Returns whether untagged items are included.
      Returns:
      the untagged item setting

    • getDetailsSectionDisplay

      public org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.DetailsSectionDisplay> getDetailsSectionDisplay()
      Returns the report details section display setting.
      Returns:
      the display setting

    • getFilterWantedStatuses

      public org.gradle.api.provider.SetProperty<String> getFilterWantedStatuses()
      Returns the statuses to include in tracing.
      Returns:
      the status filter

    • setReportVerbosity

      public void setReportVerbosity(String reportVerbosity)
      Sets the report verbosity by name.
      Parameters:
      reportVerbosity - verbosity name

    • setReportVerbosity

      public void setReportVerbosity(org.itsallcode.openfasttrace.api.report.ReportVerbosity reportVerbosity)
      Sets the report verbosity.
      Parameters:
      reportVerbosity - verbosity to use

    • setReportColorScheme

      public void setReportColorScheme(String reportColorScheme)
      Sets the report color scheme.
      Parameters:
      reportColorScheme - color scheme to use

    • setReportColorScheme

      public void setReportColorScheme(org.itsallcode.openfasttrace.api.ColorScheme reportColorScheme)
      Sets the report color scheme.
      Parameters:
      reportColorScheme - color scheme to use

    • setReportFormat

      public void setReportFormat(String reportFormat)
      Sets the report format.
      Parameters:
      reportFormat - format to use

    • setInputDirectories

      public void setInputDirectories(org.gradle.api.file.ConfigurableFileCollection inputDirectories)
      Sets the directories containing requirements.
      Parameters:
      inputDirectories - directories to use

    • setReportFile

      public void setReportFile(org.gradle.api.file.RegularFileProperty reportFile)
      Sets the report output file.
      Parameters:
      reportFile - file to write

    • setImportedRequirements

      public void setImportedRequirements(List<Object> importedRequirements)
      Sets the external requirement dependencies.
      Parameters:
      importedRequirements - dependencies to import

    • setFilteredTags

      public void setFilteredTags(List<String> filteredTags)
      Sets the tags to include in tracing.
      Parameters:
      filteredTags - tags to include

    • setFilteredArtifactTypes

      public void setFilteredArtifactTypes(List<String> filteredArtifactTypes)
      Sets the artifact types to include in tracing.
      Parameters:
      filteredArtifactTypes - artifact types to include

    • setFilterAcceptsItemsWithoutTag

      public void setFilterAcceptsItemsWithoutTag(boolean filterAcceptsItemsWithoutTag)
      Sets whether untagged items are included.
      Parameters:
      filterAcceptsItemsWithoutTag - whether to include untagged items

    • setDetailsSectionDisplay

      public void setDetailsSectionDisplay(org.itsallcode.openfasttrace.api.DetailsSectionDisplay detailsSectionDisplay)
      Sets the report details section display setting by name.
      Parameters:
      detailsSectionDisplay - display setting name

    • setDetailsSectionDisplay

      public void setDetailsSectionDisplay(String detailsSectionDisplay)
      Sets the report details section display setting by name.
      Parameters:
      detailsSectionDisplay - display setting name

    • setFilterWantedStatuses

      public void setFilterWantedStatuses(Set<String> statuses)
      Sets the statuses to include in tracing.
      Parameters:
      statuses - statuses to include

    • getTagPathConfig

      public TagPathConfiguration getTagPathConfig()
      Returns the tag path configuration.
      Returns:
      the tag path configuration

    • getFailBuild

      public org.gradle.api.provider.Property<Boolean> getFailBuild()
      Returns whether tracing defects fail the build.
      Returns:
      the fail-build property

    • setFailBuild

      public void setFailBuild(boolean failBuild)
      Sets whether tracing defects fail the build.
      Parameters:
      failBuild - whether defects should fail the build

    • toString

      public String toString()
      Overrides:
      toString in class Object