| API Documentation: | JacocoTaskExtension |
|---|
Note: This class is incubating and may change in a future version of Gradle.
Extension for tasks that should run with a Jacoco agent to generate coverage execution data.
| Property | Description |
address | Incubating IP address or hostname to use with |
append | Incubating Whether or not data should be appended if the |
classDumpFile | Incubating Path to dump all class files the agent sees are dumped to. Defaults to no dumps. |
destinationFile | Incubating The path for the execution data to be written to. |
dumpOnExit | Incubating Whether or not to dump the coverage data at VM shutdown. Defaults to |
excludeClassLoaders | Incubating List of classloader names that should be excluded from analysis. Names can use wildcards (* and ?). Defaults to an empty list. |
excludes | Incubating List of class names that should be excluded from analysis. Names can use wildcard (* and ?). Defaults to an empty list. |
includes | Incubating List of class names that should be included in analysis. Names can use wildcards (* and ?). If left empty, all classes will be included. Defaults to an empty list. |
jmx | Incubating Whether or not to expose functionality via JMX under |
output | Incubating THe type of output to generate. Defaults to |
port | Incubating Port to bind to for |
sessionId | Incubating An identifier for the session written to the execution data. Defaults to an auto-generated identifier. |
| Method | Description |
getAsJvmArg() | Incubating Creates a Jacoco task extension. |
String address
Note: This property is incubating and may change in a future version of Gradle.
IP address or hostname to use with Output.TCP_SERVER or
Output.TCP_CLIENT. Defaults to localhost.
Note: This property is incubating and may change in a future version of Gradle.
Whether or not data should be appended if the destinationFile
already exists. Defaults to true.
File classDumpFile
Note: This property is incubating and may change in a future version of Gradle.
Path to dump all class files the agent sees are dumped to. Defaults to no dumps.
File destinationFile
Note: This property is incubating and may change in a future version of Gradle.
The path for the execution data to be written to.
Note: This property is incubating and may change in a future version of Gradle.
Whether or not to dump the coverage data at VM shutdown. Defaults to true.
Note: This property is incubating and may change in a future version of Gradle.
List of classloader names that should be excluded from analysis. Names can use wildcards (* and ?). Defaults to an empty list.
Note: This property is incubating and may change in a future version of Gradle.
List of class names that should be excluded from analysis. Names can use wildcard (* and ?). Defaults to an empty list.
Note: This property is incubating and may change in a future version of Gradle.
List of class names that should be included in analysis. Names can use wildcards (* and ?). If left empty, all classes will be included. Defaults to an empty list.
Note: This property is incubating and may change in a future version of Gradle.
Whether or not to expose functionality via JMX under org.jacoco:type=Runtime.
Defaults to false.
The configuration of the jmx property is only taken into account if the used JaCoCo version
supports this option (JaCoCo version >= 0.6.2)
Output output
Note: This property is incubating and may change in a future version of Gradle.
THe type of output to generate. Defaults to Output.FILE.
Note: This property is incubating and may change in a future version of Gradle.
Port to bind to for Output.TCP_SERVER or Output.TCP_CLIENT.
Defaults to 6300.
String sessionId
Note: This property is incubating and may change in a future version of Gradle.
An identifier for the session written to the execution data. Defaults to an auto-generated identifier.
String getAsJvmArg()
Note: This method is incubating and may change in a future version of Gradle.
Creates a Jacoco task extension.