java.lang.Comparable<Task>
, org.gradle.api.internal.DynamicObjectAware
, org.gradle.api.internal.TaskInternal
, ExtensionAware
, Task
, Configurable<Task>
@DisableCachingByDefault(because="Produces only non-cacheable console output") public abstract class DependencyInsightReportTask extends DefaultTask
While the regular dependencies report (DependencyReportTask
) shows the path from the top level dependencies down through the transitive dependencies,
the dependency insight report shows the path from a particular dependency to the dependencies that pulled it in.
That is, it is an inverted view of the regular dependencies report.
The task requires setting the dependency spec and the configuration.
For more information on how to configure those please refer to docs for setDependencySpec(Object)
and
setConfiguration(String)
.
The task can also be configured from the command line.
For more information please refer to setDependencySpec(Object)
, setConfiguration(String)
,
setShowSinglePathToDependency(boolean)
, and getShowingAllVariants()
.
Task.Namer
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor | Description |
---|---|
DependencyInsightReportTask() |
Modifier and Type | Method | Description |
---|---|---|
protected org.gradle.api.internal.attributes.ImmutableAttributesFactory |
getAttributesFactory() |
An injected
ImmutableAttributesFactory . |
Configuration |
getConfiguration() |
Configuration to look the dependency in
|
Spec<DependencyResult> |
getDependencySpec() |
Selects the dependency (or dependencies if multiple matches found) to show the report for.
|
Property<ResolvedComponentResult> |
getRootComponentProperty() |
The root component of the dependency graph to be inspected.
|
Property<java.lang.Boolean> |
getShowingAllVariants() |
Show all variants of each displayed dependency.
|
protected org.gradle.internal.logging.text.StyledTextOutputFactory |
getTextOutputFactory() |
|
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() |
|
boolean |
isShowSinglePathToDependency() |
Tells if the report should only show one path to each dependency.
|
void |
report() |
|
void |
setConfiguration(java.lang.String configurationName) |
Sets the configuration (via name) to look the dependency in.
|
void |
setConfiguration(Configuration configuration) |
Sets the configuration to look the dependency in.
|
void |
setDependencySpec(java.lang.Object dependencyInsightNotation) |
Configures the dependency to show the report for.
|
void |
setDependencySpec(Spec<DependencyResult> dependencySpec) |
The dependency spec selects the dependency (or dependencies if multiple matches found) to show the report for.
|
void |
setShowSinglePathToDependency(boolean showSinglePathToDependency) |
Tells if the report should only display a single path to each dependency, which
can be useful when the graph is large.
|
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
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
@Input @Optional @Incubating public Property<ResolvedComponentResult> getRootComponentProperty()
@Internal @Nullable public Spec<DependencyResult> getDependencySpec()
public void setDependencySpec(@Nullable Spec<DependencyResult> dependencySpec)
DependencyResult
as parameter.public void setDependencySpec(@Nullable java.lang.Object dependencyInsightNotation)
Spec
and groovy closures. Spec and closure receive DependencyResult
as parameter.
Examples of String notation: 'org.slf4j:slf4j-api', 'slf4j-api', or simply: 'slf4j'.
The input may potentially match multiple dependencies.
See also setDependencySpec(Spec)
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --dependency slf4j
@Internal @Nullable public Configuration getConfiguration()
public void setConfiguration(@Nullable Configuration configuration)
public void setConfiguration(@Nullable java.lang.String configurationName)
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --configuration runtime --dependency slf4j
@Internal public boolean isShowSinglePathToDependency()
public void setShowSinglePathToDependency(boolean showSinglePathToDependency)
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --single-path
@Incubating @Internal public Property<java.lang.Boolean> getShowingAllVariants()
Due to internal limitations, this option only works when the configuration
is
unresolved before the execution of this task.
This method is exposed to the command line interface. Example usage:
gradle dependencyInsight --all-variants
@Inject protected org.gradle.internal.logging.text.StyledTextOutputFactory getTextOutputFactory()
@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.attributes.ImmutableAttributesFactory getAttributesFactory()
ImmutableAttributesFactory
.public void report()