java.lang.Comparable<Task>
, org.gradle.api.internal.DynamicObjectAware
, org.gradle.api.internal.IConventionAware
, org.gradle.api.internal.TaskInternal
, ExtensionAware
, Reporting<DependencyReportContainer>
, Task
, Configurable<Task>
@UntrackedTask(because="We can\'t describe the dependency tree of all projects as input") public abstract 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.outputLocation = 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 org.gradle.api.internal.CollectionCallbackActionDecorator |
getCallbackActionDecorator() |
Required for decorating reports container callbacks for tracing user code application.
|
protected ObjectFactory |
getObjectFactory() |
|
DirectoryProperty |
getProjectReportDirectory() |
Returns the project report directory.
|
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(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.
|
conventionMapping, conventionMapping, getConventionMapping
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
@Internal public DirectoryProperty getProjectReportDirectory()
public DependencyReportContainer getReports()
Reporting
ReportContainer
instance.
Implementers specify a specific implementation of ReportContainer
that describes the types of reports that
are available.
getReports
in interface Reporting<DependencyReportContainer>
public DependencyReportContainer reports(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()
@Inject protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()
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.