api / org.gradle.api.tasks.diagnostics / AbstractDependencyReportTask

AbstractDependencyReportTask

abstract class AbstractDependencyReportTask : AbstractReportTask

Displays the dependency tree for a configuration.

Constructors

<init>

AbstractDependencyReportTask()

Displays the dependency tree for a configuration.

Functions

generate

open fun generate(project: Project): Unit

getConfigurations

open fun getConfigurations(): MutableSet<Configuration>

Returns the configurations to generate the report for. Defaults to all configurations of this task's containing project.

getRenderer

open fun getRenderer(): ReportRenderer

getTaskConfigurations

abstract fun getTaskConfigurations(): ConfigurationContainer

setConfiguration

open fun setConfiguration(configurationName: String): Unit

Sets the single configuration (by name) to generate the report for.

setConfigurations

open fun setConfigurations(configurations: MutableSet<Configuration>): Unit

Sets the configurations to generate the report for.

setRenderer

open fun setRenderer(renderer: DependencyReportRenderer): Unit

Set the renderer to use to build a report. If unset, AsciiGraphRenderer will be used.

Inherited 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

DependencyReportTask

open class DependencyReportTask : AbstractDependencyReportTask

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