class DashboardTask extends org.gradle.api.internal.AbstractTask
A task that creates a summary report of a collection of reports generated during a build. The
summary report consists of one DashboardSection for each report included in the summary.
By default the task generates a summary of the reports from the Test, Cobertura, Scent, JDepend,
FindBugs, Checkstyle, PMD, and CPD tasks that are available in the project. Build scripts can
access and modify these standard sections through the sections property, which is a map
from task name to DashboardSection instance. New sections can also be added to this map.
The sections are logically output as a matrix where the number of columns can be configured. The HTML code that starts and ends the entire matrix, each row and each cell can also be configured.
| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.internal.AbstractTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION |
| Type | Name and description |
|---|---|
boolean |
addBuiltInSection(org.gradle.api.Task pTask)Add a built-in dashboard section for a task. |
void |
addSection(java.lang.String pName, org.gradle.api.reporting.Report pReport, java.lang.Object pXslFile)Add or modify the dashboard section with a specific name. |
void |
addSection(java.lang.String pName, org.gradle.api.reporting.Report pReport, org.gradle.api.reporting.Report pDetailedReport, java.lang.Object pXslFile)Add or modify the dashboard section with a specific name. |
org.gradle.api.Task |
configure(groovy.lang.Closure pClosure)Add the default sections before configuring the task. |
void |
createReport()Create the dashboard report with all sections that have been added to the task. |
java.lang.String |
defaultCellStartHtmlCode()Get the default cell start HTML code. |
java.lang.String |
defaultHeadlineHtmlCode()Get the default headline HTML code. |
java.lang.String |
getCellStartHtmlCode()Get the HTML code to end each section cell with. |
java.io.File |
getFooterHtmlFile()Get the HTML file that will be put after the sections in the report file. |
java.io.File |
getHeaderHtmlFile()Get the HTML file that will be put before the sections in the report file. |
java.lang.String |
getHeadlineHtmlCode()Get the HTML code for report headline to display before the matrix with all sections. |
java.util.List<DashboardSectionSnapshot> |
getInputSections()Get the dashboard section snapshots that act as input for the task. |
DashboardReports |
getReports()Get the reports produced by this task. |
java.util.Map<java.lang.String, DashboardSection> |
getSections()Get the map with the individual dashboard sections that will be included in the report. |
void |
init()Initialize the task. |
DashboardReports |
reports(groovy.lang.Closure pClosure)Configure this task's reports. |
void |
setCellStartHtmlCode(java.lang.String pCode) |
void |
setFooterHtmlFile(java.lang.Object pFile) |
void |
setHeaderHtmlFile(java.lang.Object pFile) |
void |
setHeadlineHtmlCode(java.lang.String pCode) |
void |
setSections(java.util.Map<java.lang.String, DashboardSection> pSections) |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.internal.AbstractTask |
org.gradle.api.internal.AbstractTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.internal.AbstractTask#toString(), org.gradle.api.internal.AbstractTask#compareTo(org.gradle.api.Task), org.gradle.api.internal.AbstractTask#compareTo(java.lang.Object), org.gradle.api.internal.AbstractTask#getName(), org.gradle.api.internal.AbstractTask#getActions(), org.gradle.api.internal.AbstractTask#setName(java.lang.String), org.gradle.api.internal.AbstractTask#getState(), org.gradle.api.internal.AbstractTask#getState(), org.gradle.api.internal.AbstractTask#getLogger(), org.gradle.api.internal.AbstractTask#getPath(), org.gradle.api.internal.AbstractTask#getExtensions(), org.gradle.api.internal.AbstractTask#getOutputs(), org.gradle.api.internal.AbstractTask#getOutputs(), org.gradle.api.internal.AbstractTask#getProject(), org.gradle.api.internal.AbstractTask#setActions(java.util.List), org.gradle.api.internal.AbstractTask#getTaskDependencies(), org.gradle.api.internal.AbstractTask#getTaskDependencies(), org.gradle.api.internal.AbstractTask#getDependsOn(), org.gradle.api.internal.AbstractTask#setDependsOn(java.lang.Iterable), org.gradle.api.internal.AbstractTask#dependsOn([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.AbstractTask#onlyIf(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.AbstractTask#setDidWork(boolean), org.gradle.api.internal.AbstractTask#getDidWork(), org.gradle.api.internal.AbstractTask#doFirst(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#doFirst(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#doLast(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#doLast(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#deleteAllActions(), org.gradle.api.internal.AbstractTask#getEnabled(), org.gradle.api.internal.AbstractTask#getAnt(), org.gradle.api.internal.AbstractTask#getLogging(), org.gradle.api.internal.AbstractTask#getLogging(), org.gradle.api.internal.AbstractTask#hasProperty(java.lang.String), org.gradle.api.internal.AbstractTask#getConvention(), org.gradle.api.internal.AbstractTask#setDescription(java.lang.String), org.gradle.api.internal.AbstractTask#getGroup(), org.gradle.api.internal.AbstractTask#setGroup(java.lang.String), org.gradle.api.internal.AbstractTask#dependsOnTaskDidWork(), org.gradle.api.internal.AbstractTask#getInputs(), org.gradle.api.internal.AbstractTask#getTemporaryDir(), org.gradle.api.internal.AbstractTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getMustRunAfter(), org.gradle.api.internal.AbstractTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getFinalizedBy(), org.gradle.api.internal.AbstractTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getShouldRunAfter(), org.gradle.api.internal.AbstractTask#getDescription(), org.gradle.api.internal.AbstractTask#isEnabled(), org.gradle.api.internal.AbstractTask#getAsDynamicObject(), org.gradle.api.internal.AbstractTask#property(java.lang.String), org.gradle.api.internal.AbstractTask#setProject(org.gradle.api.Project), org.gradle.api.internal.AbstractTask#execute(), org.gradle.api.internal.AbstractTask#leftShift(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#setEnabled(boolean), org.gradle.api.internal.AbstractTask#configure(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#configure(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#getStandardOutputCapture(), org.gradle.api.internal.AbstractTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.util.concurrent.Callable), org.gradle.api.internal.AbstractTask#getTaskActions(), org.gradle.api.internal.AbstractTask#getOnlyIf(), org.gradle.api.internal.AbstractTask#getExecuter(), org.gradle.api.internal.AbstractTask#executeWithoutThrowingTaskFailure(), org.gradle.api.internal.AbstractTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.internal.AbstractTask#getValidators(), org.gradle.api.internal.AbstractTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.internal.AbstractTask#getImpliesSubProjects(), org.gradle.api.internal.AbstractTask#setImpliesSubProjects(boolean), org.gradle.api.internal.AbstractTask#getTemporaryDirFactory(), org.gradle.api.internal.AbstractTask#wait(long, int), org.gradle.api.internal.AbstractTask#wait(long), org.gradle.api.internal.AbstractTask#wait(), org.gradle.api.internal.AbstractTask#equals(java.lang.Object), org.gradle.api.internal.AbstractTask#hashCode(), org.gradle.api.internal.AbstractTask#getClass(), org.gradle.api.internal.AbstractTask#notify(), org.gradle.api.internal.AbstractTask#notifyAll() |
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
The HTML code to end each section cell with. Default is </td>.
The number of columns to present the sections in. Default is 2.
The HTML title of the report. Default is "<project name> build reports summary"
This string will be placed inside the <title> tag in the HTML head.
The HTML code to end each row of sections with. Default is </tr>.
The HTML code to start each row of sections with. Default is <tr>.
The HTML code to end the sections matrix with. Default is </table>.
The HTML code to start the sections matrix with. Default is <table width="100%">.
Should the path to the report file be logged after it has been created?
Add a built-in dashboard section for a task.
pTask - The task to add a dashboard section for.Add or modify the dashboard section with a specific name.
pName - The name of the dashboard section.pReport - The XML report to transform.pXslFile - The XSL file to transform the report with.Add or modify the dashboard section with a specific name.
pName - The name of the dashboard section.pReport - The XML report to transform.pDetailedReport - The detailed report to refer to from the dashboard section.pXslFile - The XSL file to transform the report with.Add the default sections before configuring the task.
pClosure - The closure to configure the task with.Create the dashboard report with all sections that have been added to the task.
Get the default cell start HTML code.
Get the default headline HTML code.
Get the HTML code to end each section cell with. Default is
<td width="x%" valign="top"> where "x%" is the number of columns
specified in the property columns divided by 100%.
Get the HTML file that will be put after the sections in the report file. If this file is not specified, a default footer file will be used.
Get the HTML file that will be put before the sections in the report file. If this file is not specified, a default header file will be used.
Get the HTML code for report headline to display before the matrix with all sections. Default
is <p class="headline">htmlTitle<p> where "htmlTitle" is
the property htmlTitle.
Get the dashboard section snapshots that act as input for the task. The map property
sections is not suitable for input as the values are DashboardSection
instances which cannot be serialized (due to Report implementations not being
serializable).
Get the reports produced by this task.
Get the map with the individual dashboard sections that will be included in the report.
Initialize the task.
Configure this task's reports.
pClosure - A closure that configures the reports.