Package org.gradle.testing.jacoco.tasks
Class JacocoReportBase
- java.lang.Object
-
- org.gradle.api.internal.AbstractTask
-
- org.gradle.api.DefaultTask
-
- org.gradle.testing.jacoco.tasks.JacocoBase
-
- org.gradle.testing.jacoco.tasks.JacocoReportBase
-
- All Implemented Interfaces:
Comparable<Task>
,org.gradle.api.internal.DynamicObjectAware
,org.gradle.api.internal.TaskInternal
,ExtensionAware
,Task
,org.gradle.util.Configurable<Task>
- Direct Known Subclasses:
JacocoCoverageVerification
,JacocoReport
@Incubating public abstract class JacocoReportBase extends JacocoBase
Base class for Jacoco report tasks.- Since:
- 3.4
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
-
Field Summary
-
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
-
Constructor Summary
Constructors Constructor Description JacocoReportBase()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
additionalClassDirs(File... dirs)
Adds additional class directories to those that will be included in the report.void
additionalClassDirs(FileCollection dirs)
Adds additional class directories to those that will be included in the report.void
additionalSourceDirs(File... dirs)
Adds additional source directories to be used for any classes included in the report.void
additionalSourceDirs(FileCollection dirs)
Adds additional source directories to be used for any classes included in the report.void
executionData(Object... files)
Adds execution data files to be used during coverage analysis.void
executionData(Task... tasks)
Adds execution data generated by a task to the list of those used during coverage analysis.void
executionData(TaskCollection tasks)
Adds execution data generated by the given tasks to the list of those used during coverage analysis.FileCollection
getAdditionalClassDirs()
Additional class dirs that coverage data should be reported for.FileCollection
getAdditionalSourceDirs()
Additional source dirs for the classes coverage data is being reported for.FileCollection
getAllClassDirs()
Gets the class directories that coverage will be reported for.FileCollection
getAllSourceDirs()
Gets the source directories for the classes that will be reported on.protected org.gradle.api.internal.project.IsolatedAntBuilder
getAntBuilder()
FileCollection
getClassDirectories()
Source sets that coverage should be reported for.FileCollection
getExecutionData()
Collection of execution data files to analyze.protected org.gradle.internal.reflect.Instantiator
getInstantiator()
FileCollection
getSourceDirectories()
Source sets that coverage should be reported for.void
setAdditionalClassDirs(FileCollection additionalClassDirs)
void
setAdditionalSourceDirs(FileCollection additionalSourceDirs)
void
setClassDirectories(FileCollection classDirectories)
void
setExecutionData(FileCollection executionData)
void
setSourceDirectories(FileCollection sourceDirectories)
void
sourceSets(SourceSet... sourceSets)
Adds a source set to the list to be reported on.-
Methods inherited from class org.gradle.testing.jacoco.tasks.JacocoBase
getJacocoClasspath, setJacocoClasspath
-
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
-
Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
-
-
-
Method Detail
-
getInstantiator
@Inject protected org.gradle.internal.reflect.Instantiator getInstantiator()
-
getAntBuilder
@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
-
getExecutionData
@PathSensitive(NONE) @InputFiles public FileCollection getExecutionData()
Collection of execution data files to analyze.
-
setExecutionData
public void setExecutionData(FileCollection executionData)
-
getSourceDirectories
@PathSensitive(RELATIVE) @InputFiles public FileCollection getSourceDirectories()
Source sets that coverage should be reported for.
-
setSourceDirectories
public void setSourceDirectories(FileCollection sourceDirectories)
-
getClassDirectories
@PathSensitive(RELATIVE) @InputFiles public FileCollection getClassDirectories()
Source sets that coverage should be reported for.
-
setClassDirectories
public void setClassDirectories(FileCollection classDirectories)
-
getAdditionalClassDirs
@Optional @PathSensitive(RELATIVE) @InputFiles public FileCollection getAdditionalClassDirs()
Additional class dirs that coverage data should be reported for.
-
setAdditionalClassDirs
public void setAdditionalClassDirs(FileCollection additionalClassDirs)
-
getAdditionalSourceDirs
@Optional @PathSensitive(RELATIVE) @InputFiles public FileCollection getAdditionalSourceDirs()
Additional source dirs for the classes coverage data is being reported for.
-
setAdditionalSourceDirs
public void setAdditionalSourceDirs(FileCollection additionalSourceDirs)
-
executionData
public void executionData(Object... files)
Adds execution data files to be used during coverage analysis.- Parameters:
files
- one or more files to add
-
executionData
public void executionData(Task... tasks)
Adds execution data generated by a task to the list of those used during coverage analysis. Only tasks with aJacocoTaskExtension
will be included; all others will be ignored.- Parameters:
tasks
- one or more tasks to add
-
executionData
public void executionData(TaskCollection tasks)
Adds execution data generated by the given tasks to the list of those used during coverage analysis. Only tasks with aJacocoTaskExtension
will be included; all others will be ignored.- Parameters:
tasks
- one or more tasks to add
-
getAllClassDirs
@Internal public FileCollection getAllClassDirs()
Gets the class directories that coverage will be reported for. All classes in these directories will be included in the report.- Returns:
- class dirs to report coverage of
-
getAllSourceDirs
@Internal public FileCollection getAllSourceDirs()
Gets the source directories for the classes that will be reported on. Source will be obtained from these directories only for the classes included in the report.- Returns:
- source directories for the classes reported on
- See Also:
getAllClassDirs()
-
sourceSets
public void sourceSets(SourceSet... sourceSets)
Adds a source set to the list to be reported on. The output of this source set will be used as classes to include in the report. The source for this source set will be used for any classes included in the report.- Parameters:
sourceSets
- one or more source sets to report on
-
additionalClassDirs
public void additionalClassDirs(File... dirs)
Adds additional class directories to those that will be included in the report.- Parameters:
dirs
- one or more directories containing classes to report coverage of
-
additionalClassDirs
public void additionalClassDirs(FileCollection dirs)
Adds additional class directories to those that will be included in the report.- Parameters:
dirs
- aFileCollection
of directories containing classes to report coverage of
-
additionalSourceDirs
public void additionalSourceDirs(File... dirs)
Adds additional source directories to be used for any classes included in the report.- Parameters:
dirs
- one or more directories containing source files for the classes included in the report
-
additionalSourceDirs
public void additionalSourceDirs(FileCollection dirs)
Adds additional source directories to be used for any classes included in the report.- Parameters:
dirs
- aFileCollection
of directories containing source files for the classes included in the report
-
-