api / org.gradle.api.tasks.diagnostics / AbstractReportTask

AbstractReportTask

abstract class AbstractReportTask : ConventionTask

The base class for all project report tasks.

Functions

generate

open fun generate(): Unit

getOutputFile

open fun getOutputFile(): File

Returns the file which the report will be written to. When set to null, the report is written to System.out. Defaults to null.

getProjects

open fun getProjects(): MutableSet<Project>

Returns the set of project to generate this report for. By default, the report is generated for the task's containing project.

setOutputFile

open fun setOutputFile(outputFile: File): Unit

Sets the file which the report will be written to. Set this to null to write the report to System.out.

setProjects

open fun setProjects(projects: MutableSet<Project>): Unit

Specifies the set of projects to generate this report for.

Inheritors

AbstractDependencyReportTask

abstract class AbstractDependencyReportTask : AbstractReportTask

Displays the dependency tree for a configuration.

ProjectReportTask

open class ProjectReportTask : AbstractReportTask

Displays a list of projects in the build. An instance of this type is used when you execute the projects task from the command-line.

PropertyReportTask

open class PropertyReportTask : AbstractReportTask

Displays the properties of a project. An instance of this type is used when you execute the properties task from the command-line.

TaskReportTask

open class TaskReportTask : AbstractReportTask

Displays a list of tasks in the project. An instance of this type is used when you execute the tasks task from the command-line.

By default, this report shows only those tasks which have been assigned to a task group, so-called visible tasks. Tasks which have not been assigned to a task group, so-called hidden tasks, can be included in the report by enabling the command line option --all.