Class HtmlDependencyReportTask
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.diagnostics.ConventionReportTask
org.gradle.api.tasks.diagnostics.AbstractProjectBasedReportTask<AbstractDependencyReportTask.DependencyReportModel>
org.gradle.api.tasks.diagnostics.AbstractDependencyReportTask
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,- Named,- 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 AbstractDependencyReportTask
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 reports.html.destination property:
 
 htmlDependencyReport {
     reports.html.outputLocation = file("build/reports/project/dependencies")
 }
 - 
Nested Class SummaryNested classes/interfaces inherited from class org.gradle.api.tasks.diagnostics.AbstractDependencyReportTaskAbstractDependencyReportTask.DependencyReportModelNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidgenerate()protected org.gradle.api.internal.CollectionCallbackActionDecoratorRequired for decorating reports container callbacks for tracing user code application.protected ObjectFactoryAReportContainerinstance.protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionComparatorprotected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParserprotected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorSchemeAllow configuration of the report container by closure.reports(Action<? super DependencyReportContainer> configureAction) Allow configuration of the report container by closure.Methods inherited from class org.gradle.api.tasks.diagnostics.AbstractDependencyReportTaskcalculateReportModelFor, generateReportFor, getConfigurations, getRenderer, getTaskConfigurations, setConfiguration, setConfigurations, setRendererMethods inherited from class org.gradle.api.tasks.diagnostics.AbstractProjectBasedReportTaskgenerateReportFooterFor, generateReportHeaderForMethods inherited from class org.gradle.api.tasks.diagnostics.ConventionReportTaskgetClientMetaData, getOutputFile, getProjectReportDirectory, getProjects, getTextOutputFactory, setOutputFile, setProjectsMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
HtmlDependencyReportTaskpublic HtmlDependencyReportTask()
 
- 
- 
Method Details- 
getReportsDescription copied from interface:ReportingAReportContainerinstance.Implementers specify a specific implementation of ReportContainerthat describes the types of reports that are available.- Specified by:
- getReportsin interface- Reporting<DependencyReportContainer>
- Returns:
- The report container
 
- 
reportsDescription copied from interface:ReportingAllow configuration of the report container by closure.reports { html { required false } xml.outputLocation = "build/reports/myReport.xml" }- Specified by:
- reportsin interface- Reporting<DependencyReportContainer>
- Parameters:
- closure- The configuration
- Returns:
- The report container
 
- 
reportsDescription copied from interface:ReportingAllow configuration of the report container by closure.reports { html { required false } xml.outputLocation = "build/reports/myReport.xml" }- Specified by:
- reportsin interface- Reporting<DependencyReportContainer>
- Parameters:
- configureAction- The configuration
- Returns:
- The report container
 
- 
getObjectFactory
- 
getVersionSelectorScheme@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme getVersionSelectorScheme()
- 
getVersionComparator@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionComparator getVersionComparator()
- 
getVersionParser@Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser getVersionParser()
- 
getCallbackActionDecorator@Inject protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()Required for decorating reports container callbacks for tracing user code application.- Since:
- 5.1
 
- 
generatepublic void generate()
 
-