Reporting<DependencyReportContainer>
public class HtmlDependencyReportTask extends org.gradle.api.internal.ConventionTask implements Reporting<DependencyReportContainer>
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 reports.html.destination
property:
htmlDependencyReport { reports.html.destination = file("build/reports/project/dependencies") }
Task.Namer
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor | Description |
---|---|
HtmlDependencyReportTask() |
Modifier and Type | Method | Description |
---|---|---|
void |
generate() |
|
protected ObjectFactory |
getObjectFactory() |
|
java.util.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.VersionComparator |
getVersionComparator() |
|
protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser |
getVersionParser() |
|
protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme |
getVersionSelectorScheme() |
|
DependencyReportContainer |
reports(groovy.lang.Closure closure) |
Allow configuration of the report container by closure.
|
DependencyReportContainer |
reports(Action<? super DependencyReportContainer> configureAction) |
Allow configuration of the report container by closure.
|
void |
setProjects(java.util.Set<Project> projects) |
Specifies the set of projects to generate this report for.
|
appendParallelSafeAction, compareTo, configure, 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, getServices, 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
conventionMapping, conventionMapping, getConventionMapping
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
public DependencyReportContainer getReports()
Reporting
ReportContainer
instance.
Implementors specify a specific implementation of ReportContainer
that describes the types of reports that
are available.
getReports
in interface Reporting<DependencyReportContainer>
public DependencyReportContainer reports(groovy.lang.Closure closure)
Reporting
reports { html { enabled false } xml.destination "build/reports/myReport.xml" }
reports
in interface Reporting<DependencyReportContainer>
closure
- The configurationpublic DependencyReportContainer reports(Action<? super DependencyReportContainer> configureAction)
Reporting
reports { html { enabled false } xml.destination "build/reports/myReport.xml" }
reports
in interface Reporting<DependencyReportContainer>
configureAction
- The configuration@Inject protected ObjectFactory getObjectFactory()
@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme getVersionSelectorScheme()
@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionComparator getVersionComparator()
@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser getVersionParser()
public void generate()
@Internal public java.util.Set<Project> getProjects()
public void setProjects(java.util.Set<Project> projects)
projects
- The set of projects. Must not be null.