org.gradle.api.tasks.diagnostics
Class DependencyReportTask

java.lang.Object
  extended by org.gradle.api.internal.AbstractTask
      extended by org.gradle.api.DefaultTask
          extended by org.gradle.api.internal.ConventionTask
              extended by org.gradle.api.tasks.diagnostics.AbstractReportTask
                  extended by org.gradle.api.tasks.diagnostics.DependencyReportTask
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Task, org.gradle.util.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.


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
DependencyReportTask()
           
 
Method Summary
 void generate(Project project)
           
 Set<Configuration> getConfigurations()
          Returns the configurations to generate the report for.
 org.gradle.api.tasks.diagnostics.internal.ReportRenderer getRenderer()
           
 void setConfigurations(Set<Configuration> configurations)
          Sets the configurations to generate the report for.
 void setRenderer(org.gradle.api.tasks.diagnostics.internal.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, getConventionMapping, setConventionMapping
 
Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, 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 org.gradle.api.tasks.diagnostics.internal.ReportRenderer getRenderer()
Specified by:
getRenderer in class AbstractReportTask

setRenderer

public void setRenderer(org.gradle.api.tasks.diagnostics.internal.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.