org.gradle.api.reporting.dependencies

Class HtmlDependencyReportTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.reporting.dependencies.HtmlDependencyReportTask

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Reporting<DependencyReportContainer>, Task, org.gradle.util.Configurable<Task>

@Incubating
public class HtmlDependencyReportTask
extends org.gradle.api.internal.ConventionTask
implements Reporting<DependencyReportContainer>

Generates an HTML dependency report. This report combines the features of the ASCII dependency report and those of the ASCII dependency insight report. For a given project, it generates a tree of the dependencies of every configuration, and each dependency can be clicked to show the insight of this dependency.

This task generates a report for the task's containing project by default. But it can also generate a report for multiple projects, by setting the value of the projects property. Here's how to generate an HTML dependency report for all the projects of a multi-project build, for example:

 htmlDependencyReport {
     projects = project.allprojects
 }
 

The report is generated in the build/reports/project/dependencies directory by default. This can also be changed by setting the outputDirectory property.

Nested Class Summary

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

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
HtmlDependencyReportTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	generate()
protected org.gradle.internal.reflect.Instantiator	getInstantiator()
Set<Project>	getProjects() Returns the set of projects to generate a report for.
DependencyReportContainer	getReports() A ReportContainer instance.
protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionMatcher	getVersionMatcher()
DependencyReportContainer	reports(Closure closure) Allow configuration of the report container by closure.
void	setProjects(Set<Project> projects) Specifies the set of projects to generate this report for.

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

conventionMapping, conventionMapping, getConventionMapping

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

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlDependencyReportTask

public HtmlDependencyReportTask()

Method Detail

getReports

public DependencyReportContainer getReports()

Description copied from interface: Reporting

A ReportContainer instance.

Implementors specify a specific implementation of ReportContainer that describes the types of reports that are available.

Specified by:

getReports in interface Reporting<DependencyReportContainer>

Returns:

The report container

reports

public DependencyReportContainer reports(Closure closure)

Description copied from interface: Reporting

Allow configuration of the report container by closure.

 reports {
   html {
     enabled false
   }
   xml.destination "build/reports/myReport.xml"
 }
 

Specified by:

reports in interface Reporting<DependencyReportContainer>

Parameters:

closure - The configuration

Returns:

The report container

getInstantiator

@Inject
protected org.gradle.internal.reflect.Instantiator getInstantiator()

getVersionMatcher

@Inject
protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionMatcher getVersionMatcher()

generate

public void generate()

getProjects

public Set<Project> getProjects()

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

Returns:

The set of files.

setProjects

public void setProjects(Set<Project> projects)

Specifies the set of projects to generate this report for.

Parameters:

projects - The set of projects. Must not be null.