org.gradle.api.tasks.diagnostics

Class DependencyReportTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.diagnostics.AbstractReportTask

org.gradle.api.tasks.diagnostics.DependencyReportTask

All Implemented Interfaces:

Comparable<Task>, DynamicObjectAware, IConventionAware, TaskInternal, ExtensionAware, Task, Configurable<Task>

public class DependencyReportTask
extends AbstractReportTask

Displays the dependency tree for a project. Can be configured to output to a file, and to optionally output a graphviz compatible "dot" graph. An instance of this type is used when you execute the dependencies task from the command-line.

Author:

Phil Messenger

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
DependencyReportTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(Project project)
Set<Configuration>	getConfigurations() Returns the configurations to generate the report for.
ReportRenderer	getRenderer()
void	setConfigurations(Set<Configuration> configurations) Sets the configurations to generate the report for.
void	setRenderer(DependencyReportRenderer renderer) Set the renderer to use to build a report.

Methods inherited from class org.gradle.api.tasks.diagnostics.AbstractReportTask

generate, getOutputFile, getProjects, setOutputFile, setProjects

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, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyReportTask

public DependencyReportTask()

Method Detail

getRenderer

public ReportRenderer getRenderer()

Specified by:

getRenderer in class AbstractReportTask

setRenderer

public void setRenderer(DependencyReportRenderer renderer)

Set the renderer to use to build a report. If unset, AsciiGraphRenderer will be used.

generate

public void generate(Project project)
              throws IOException

Specified by:

generate in class AbstractReportTask

Throws:

IOException

getConfigurations

public Set<Configuration> getConfigurations()

Returns the configurations to generate the report for. Default to all configurations of this task's containing project.

Returns:

the configurations.

setConfigurations

public void setConfigurations(Set<Configuration> configurations)

Sets the configurations to generate the report for.

Parameters:

configurations - The configuration. Must not be null.