org.myire.quill.dashboard

Class DashboardTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.myire.quill.dashboard.DashboardTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>, ReportingEntity<DashboardReports>

public class DashboardTask
extends org.gradle.api.DefaultTask
implements ReportingEntity<DashboardReports>

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 for the tasks represented by the sections returned by DashboardSectionFactory.createAvailableDefaultSections(). 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 layout of the dashboard sections can be configured through the task's layout property.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
DashboardTask()

Method Summary

Modifier and Type	Method 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.util.List<org.myire.quill.dashboard.DashboardTask.DashboardSectionSpec>	getInputSections() Get the map with the individual dashboard sections that will be included in the report.
DashboardLayout	getLayout() Get the layout of the dashboard.
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.
boolean	isVerbose() Should the path to the report file be logged after it has been created?
DashboardLayout	layout(groovy.lang.Closure pClosure) Configure the dashboard's layout.
DashboardSection	removeSection(java.lang.String pName) Remove a dashboard section with a specific name.
DashboardReports	reports(org.gradle.api.Action<? super DashboardReports> pAction) Configure this task's reports.
DashboardReports	reports(groovy.lang.Closure pClosure) Configure this task's reports.
void	setVerbose(boolean pVerbose)

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, compareTo, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString, usesService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DashboardTask

public DashboardTask()

Method Detail

configure

public org.gradle.api.Task configure(groovy.lang.Closure pClosure)

Add the default sections before configuring the task.

Specified by:

configure in interface org.gradle.api.Task

Specified by:

configure in interface org.gradle.util.Configurable<org.gradle.api.Task>

Overrides:

configure in class org.gradle.api.internal.AbstractTask

Parameters:

pClosure - The closure to configure the task with.

Returns:

This task.

isVerbose

@Input
public boolean isVerbose()

Should the path to the report file be logged after it has been created?

Returns:

True if the path should be logged, false if not.

setVerbose

public void setVerbose(boolean pVerbose)

getLayout

public DashboardLayout getLayout()

Get the layout of the dashboard.

Returns:

The dashboard's layout.

layout

public DashboardLayout layout(groovy.lang.Closure pClosure)

Configure the dashboard's layout.

Parameters:

pClosure - A closure that configures the layout.

Returns:

The dashboard's layout.

getReports

public DashboardReports getReports()

Get the reports produced by this task.

Specified by:

getReports in interface ReportingEntity<DashboardReports>

Returns:

The reports.

reports

public DashboardReports reports(groovy.lang.Closure pClosure)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<DashboardReports>

Parameters:

pClosure - A closure that configures the reports.

Returns:

This task's reports.

reports

public DashboardReports reports(org.gradle.api.Action<? super DashboardReports> pAction)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<DashboardReports>

Parameters:

pAction - An action that configures the reports.

Returns:

This task's reports.

getInputSections

@Input
public java.util.List<org.myire.quill.dashboard.DashboardTask.DashboardSectionSpec> getInputSections()

Get the map with the individual dashboard sections that will be included in the report.

Returns:

The report's sections.

getSections

@Internal
public java.util.Map<java.lang.String,DashboardSection> getSections()

Get the map with the individual dashboard sections that will be included in the report.

Returns:

The report's sections.

addSection

public 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.

Parameters:

pName - The name of the dashboard section.

pReport - The XML report to transform.

pXslFile - The XSL file to transform the report with.

addSection

public 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.

Parameters:

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.

addBuiltInSection

public boolean addBuiltInSection(org.gradle.api.Task pTask)

Add a built-in dashboard section for a task. The XSL used for transforming the task's report(s) will be the XSL resource bundled with the Quill distribution..

Parameters:

pTask - The task to add a dashboard section for.

Returns:

True if a built-in section was added, false if there is no built-in section for the task's type.

removeSection

public DashboardSection removeSection(java.lang.String pName)

Remove a dashboard section with a specific name.

Parameters:

pName - The name of the dashboard section.

Returns:

The removed section, or null if there was no section with the specified name.

createReport

public void createReport()

Create the dashboard report with all sections that have been added to the task.