gradle/org.gradle.testing.jacoco.plugins/JacocoTaskExtension

JacocoTaskExtension

abstract class JacocoTaskExtension(source)

Extension for tasks that should run with a Jacoco agent to generate coverage execution data.

Constructors

Link copied to clipboard
@Inject
constructor(agent: JacocoAgentJar, task: JavaForkOptions)
Creates a Jacoco task extension.

Types

Link copied to clipboard
enum Output
The types of output that the agent can use for execution data.

Functions

Link copied to clipboard
@Optional
@Input
abstract fun getAddress(): Property<String>
IP address or hostname to use with TCP_SERVER or TCP_CLIENT.
Link copied to clipboard
@Classpath
open fun getAgentClasspath(): FileCollection
The Jacoco agent classpath.
Link copied to clipboard
@Internal
open fun getAsJvmArg(): Provider<String>
Gets all properties in the format expected of the agent JVM argument.
Link copied to clipboard
@ReplacedBy(value = "classDumpDirectory")
@Nullable
open fun getClassDumpDir(): @Nullable File
Path to dump all class files the agent sees are dumped to.
Link copied to clipboard
@Incubating
@Optional
@LocalState
abstract fun getClassDumpDirectory(): DirectoryProperty
Path to dump all class files the agent sees are dumped to.
Link copied to clipboard
@Internal
abstract fun getDestinationFile(): RegularFileProperty
The path for execution data to be written to.
Link copied to clipboard
@Input
abstract fun getDumpOnExit(): Property<Boolean>
Whether or not to dump the coverage data at VM shutdown.
Link copied to clipboard
@Input
abstract fun getEnabled(): Property<Boolean>
Whether or not the task should generate execution data.
Link copied to clipboard
@Optional
@Input
abstract fun getExcludeClassLoaders(): ListProperty<String>
List of classloader names that should be excluded from analysis.
Link copied to clipboard
@Optional
@Input
abstract fun getExcludes(): ListProperty<String>
List of class names that should be excluded from analysis.
Link copied to clipboard
@Input
abstract fun getIncludeNoLocationClasses(): Property<Boolean>
Whether or not classes without source location should be instrumented.
Link copied to clipboard
@Optional
@Input
abstract fun getIncludes(): ListProperty<String>
List of class names that should be included in analysis.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Internal
open fun getIsJmx(): Property<Boolean>
Link copied to clipboard
@Input
abstract fun getJmx(): Property<Boolean>
Whether or not to expose functionality via JMX under org.jacoco:type=Runtime.
Link copied to clipboard
@Input
abstract fun getOutput(): Property<JacocoTaskExtension.Output>
The type of output to generate.
Link copied to clipboard
@Input
abstract fun getPort(): Property<Integer>
Port to bind to for TCP_SERVER or TCP_CLIENT.
Link copied to clipboard
@Optional
@Input
abstract fun getSessionId(): Property<String>
An identifier for the session written to the execution data.
Link copied to clipboard
open fun setAddress(@Nullable address: @Nullable String)
Link copied to clipboard
open fun setClassDumpDir(@Nullable classDumpDir: @Nullable File)
Sets path to dump all class files the agent sees are dumped to.
Link copied to clipboard
open fun setDestinationFile(@Nullable destinationFile: @Nullable File)
Link copied to clipboard
open fun setDumpOnExit(dumpOnExit: Boolean)
Link copied to clipboard
open fun setEnabled(enabled: Boolean)
Link copied to clipboard
open fun setExcludeClassLoaders(@Nullable excludeClassLoaders: @Nullable List<String>)
Link copied to clipboard
open fun setExcludes(@Nullable excludes: @Nullable List<String>)
Link copied to clipboard
open fun setIncludeNoLocationClasses(includeNoLocationClasses: Boolean)
Link copied to clipboard
open fun setIncludes(@Nullable includes: @Nullable List<String>)
Link copied to clipboard
open fun setJmx(jmx: Boolean)
Link copied to clipboard
open fun setOutput(output: JacocoTaskExtension.Output)
Link copied to clipboard
open fun setPort(port: Int)
Link copied to clipboard
open fun setSessionId(@Nullable sessionId: @Nullable String)
Generated by Dokka
Gradle Kotlin DSL Reference