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,- Named,- ExtensionAware,- Task,- Configurable<Task>
- Direct Known Subclasses:
- JacocoCoverageVerification,- JacocoReport
@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly")
public abstract class JacocoReportBase
extends JacocoBase
Base class for Jacoco report tasks.
- Since:
- 3.4
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidadditionalClassDirs(File... dirs) Adds additional class directories to those that will be included in the report.voidAdds additional class directories to those that will be included in the report.voidadditionalSourceDirs(File... dirs) Adds additional source directories to be used for any classes included in the report.voidAdds additional source directories to be used for any classes included in the report.voidexecutionData(Object... files) Adds execution data files to be used during coverage analysis.voidexecutionData(Task... tasks) Adds execution data generated by a task to the list of those used during coverage analysis.voidexecutionData(TaskCollection tasks) Adds execution data generated by the given tasks to the list of those used during coverage analysis.Additional class dirs that coverage data should be reported for.Additional source dirs for the classes coverage data is being reported for.Gets the class directories that coverage will be reported for.Gets the source directories for the classes that will be reported on.protected org.gradle.api.internal.project.IsolatedAntBuilderprotected org.gradle.api.internal.CollectionCallbackActionDecoratorRequired for decorating reports container callbacks for tracing user code application.Source sets that coverage should be reported for.Collection of execution data files to analyze.protected org.gradle.internal.reflect.InstantiatorSource sets that coverage should be reported for.The character encoding of the source files.voidsourceSets(SourceSet... sourceSets) Adds a source set to the list to be reported on.Methods inherited from class org.gradle.testing.jacoco.tasks.JacocoBasegetJacocoClasspath, setJacocoClasspathMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
JacocoReportBasepublic JacocoReportBase()
 
- 
- 
Method Details- 
getInstantiator@Inject protected org.gradle.internal.reflect.Instantiator getInstantiator()
- 
getCallbackActionDecorator@Inject protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()Required for decorating reports container callbacks for tracing user code application.- Since:
- 5.1
 
- 
getAntBuilder@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
- 
getExecutionDataCollection of execution data files to analyze.
- 
getSourceDirectories@IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles public ConfigurableFileCollection getSourceDirectories()Source sets that coverage should be reported for.
- 
getClassDirectoriesSource sets that coverage should be reported for.
- 
getAdditionalClassDirs@Optional @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles public ConfigurableFileCollection getAdditionalClassDirs()Additional class dirs that coverage data should be reported for.
- 
getAdditionalSourceDirs@Optional @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles public ConfigurableFileCollection getAdditionalSourceDirs()Additional source dirs for the classes coverage data is being reported for.
- 
getSourceEncodingThe character encoding of the source files.- Since:
- 8.8
 
- 
executionDataAdds execution data files to be used during coverage analysis.- Parameters:
- files- one or more files to add
 
- 
executionDataAdds execution data generated by a task to the list of those used during coverage analysis. Only tasks with aJacocoTaskExtensionwill be included; all others will be ignored.- Parameters:
- tasks- one or more tasks to add
 
- 
executionDataAdds execution data generated by the given tasks to the list of those used during coverage analysis. Only tasks with aJacocoTaskExtensionwill be included; all others will be ignored.- Parameters:
- tasks- one or more tasks to add
 
- 
getAllClassDirsGets 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
 
- 
getAllSourceDirsGets 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:
 
- 
sourceSetsAdds 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
 
- 
additionalClassDirsAdds additional class directories to those that will be included in the report.- Parameters:
- dirs- one or more directories containing classes to report coverage of
 
- 
additionalClassDirsAdds additional class directories to those that will be included in the report.- Parameters:
- dirs- a- FileCollectionof directories containing classes to report coverage of
 
- 
additionalSourceDirsAdds 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
 
- 
additionalSourceDirsAdds additional source directories to be used for any classes included in the report.- Parameters:
- dirs- a- FileCollectionof directories containing source files for the classes included in the report
 
 
-