Package com.arc_e_tect.gradle.jacoco

Class JacocoExclusionReportTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask
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>
@DisableCachingByDefault(because="Report depends on source file content and is cheap to regenerate") public abstract class JacocoExclusionReportTask extends org.gradle.api.DefaultTask
Gradle task that scans Java source files for the exclusion annotation and writes HTML and XML reports to the configured output directory.

Registered automatically by JacocoExclusionReportPlugin under the name jacocoExclusionReport.

  • 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
    JacocoExclusionReportTask()
    Creates the task.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generate()
    Scans all configured source files for the exclusion annotation and writes the HTML and XML reports to getReportDir().
    abstract org.gradle.api.provider.Property<String>
    getAnnotationName()
    Simple (unqualified) name of the annotation to search for.
    abstract org.gradle.api.file.DirectoryProperty
    getReportDir()
    Directory to write the HTML and XML reports into.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSourceFiles()
    Java source files to scan.

    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

    • JacocoExclusionReportTask

      @Inject public JacocoExclusionReportTask()
      Creates the task. Instantiated by Gradle infrastructure via Inject.

  • Method Details

    • getAnnotationName

      @Input public abstract org.gradle.api.provider.Property<String> getAnnotationName()
      Simple (unqualified) name of the annotation to search for.
      Returns:
      mutable property holding the annotation simple name

    • getSourceFiles

      @InputFiles @SkipWhenEmpty @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getSourceFiles()
      Java source files to scan.
      Returns:
      mutable file collection of .java source files

    • getReportDir

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getReportDir()
      Directory to write the HTML and XML reports into.
      Returns:
      mutable directory property for the report output location

    • generate

      public void generate()
      Scans all configured source files for the exclusion annotation and writes the HTML and XML reports to getReportDir().