Package org.itsallcode.openfasttrace.gradle.task

Class TraceTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.itsallcode.openfasttrace.gradle.task.TraceTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public class TraceTask extends org.gradle.api.DefaultTask
Gradle task that traces requirements and writes a report.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    TraceTask()
    Creates the task.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.DetailsSectionDisplay>
    getDetailsSectionDisplay()
    Returns the report details section display setting.
    org.gradle.api.provider.Property<Boolean>
    getFailBuild()
    Returns whether tracing defects fail the build.
    org.gradle.api.provider.Property<Boolean>
    getFilterAcceptsItemsWithoutTag()
    Returns whether items without tags are accepted.
    org.gradle.api.provider.SetProperty<String>
    getFilteredArtifactTypes()
    Returns the artifact type filter.
    org.gradle.api.provider.SetProperty<String>
    getFilteredTags()
    Returns the tag filter.
    org.gradle.api.provider.SetProperty<org.itsallcode.openfasttrace.api.core.ItemStatus>
    getFilterWantedStatuses()
    Returns the status filter.
    org.gradle.api.file.ConfigurableFileCollection
    getImportedRequirements()
    Returns the imported requirements property.
    org.gradle.api.file.RegularFileProperty
    getOutputFile()
    Returns the generated tracing report.
    org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.ColorScheme>
    getReportColorScheme()
    Get the report color scheme property.
    org.gradle.api.provider.Property<String>
    getReportFormat()
    Returns the report format property.
    org.gradle.api.provider.Property<org.itsallcode.openfasttrace.api.report.ReportVerbosity>
    getReportVerbosity()
    Returns the report verbosity property.
    org.gradle.api.file.RegularFileProperty
    getRequirementsFile()
    Returns the collected requirements file.
    void
    trace()
    Traces the requirements and writes the report.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • TraceTask

      public TraceTask()
      Creates the task.

  • Method Details

    • getRequirementsFile

      @InputFile @PathSensitive(ABSOLUTE) public org.gradle.api.file.RegularFileProperty getRequirementsFile()
      Returns the collected requirements file.
      Returns:
      the requirements file

    • getOutputFile

      @OutputFile public org.gradle.api.file.RegularFileProperty getOutputFile()
      Returns the generated tracing report.
      Returns:
      the report file

    • getReportVerbosity

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

    • getReportColorScheme

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

    • getReportFormat

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

    • getImportedRequirements

      @InputFiles @PathSensitive(ABSOLUTE) public org.gradle.api.file.ConfigurableFileCollection getImportedRequirements()
      Returns the imported requirements property.
      Returns:
      the imported requirements property

    • getFilteredArtifactTypes

      @Input @Optional public org.gradle.api.provider.SetProperty<String> getFilteredArtifactTypes()
      Returns the artifact type filter.
      Returns:
      the artifact type filter

    • getFilteredTags

      @Input public org.gradle.api.provider.SetProperty<String> getFilteredTags()
      Returns the tag filter.
      Returns:
      the tag filter

    • getFilterAcceptsItemsWithoutTag

      @Input public org.gradle.api.provider.Property<Boolean> getFilterAcceptsItemsWithoutTag()
      Returns whether items without tags are accepted.
      Returns:
      the untagged item setting

    • getDetailsSectionDisplay

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

    • getFailBuild

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

    • getFilterWantedStatuses

      @Input @Optional public org.gradle.api.provider.SetProperty<org.itsallcode.openfasttrace.api.core.ItemStatus> getFilterWantedStatuses()
      Returns the status filter.
      Returns:
      the status filter

    • trace

      public void trace()
      Traces the requirements and writes the report.