Package org.apache.maven.plugins.dependency.tree

Class TreeMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.dependency.tree.TreeMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="tree", requiresDependencyCollection=TEST, threadSafe=true) public class TreeMojo extends org.apache.maven.plugin.AbstractMojo
Displays the dependency tree for this project. Multiple formats are supported: text (by default), but also DOT, GraphML, TGF and JSON.
Since:
2.0-alpha-5
Author:
Mark Hobson

  • Field Summary

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    TreeMojo(org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession session, org.apache.maven.shared.dependency.graph.DependencyCollectorBuilder dependencyCollectorBuilder, org.apache.maven.shared.dependency.graph.DependencyGraphBuilder dependencyGraphBuilder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
     
    org.apache.maven.shared.dependency.graph.DependencyNode
    getDependencyGraph()
    Gets the computed dependency graph root node for the Maven project.
    org.apache.maven.project.MavenProject
    getProject()
    Gets the Maven project used by this mojo.
    org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor
    getSerializingDependencyNodeVisitor(Writer writer)
     
    boolean
    isSkip()
     
    void
    setSkip(boolean skip)
     

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TreeMojo

      @Inject public TreeMojo(org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession session, org.apache.maven.shared.dependency.graph.DependencyCollectorBuilder dependencyCollectorBuilder, org.apache.maven.shared.dependency.graph.DependencyGraphBuilder dependencyGraphBuilder)

  • Method Details

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • getProject

      public org.apache.maven.project.MavenProject getProject()
      Gets the Maven project used by this mojo.
      Returns:
      the Maven project

    • getDependencyGraph

      public org.apache.maven.shared.dependency.graph.DependencyNode getDependencyGraph()
      Gets the computed dependency graph root node for the Maven project.
      Returns:
      the dependency tree root node

    • isSkip

      public boolean isSkip()
      Returns:
      skip

    • setSkip

      public void setSkip(boolean skip)
      Parameters:
      skip - skip

    • getSerializingDependencyNodeVisitor

      public org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor getSerializingDependencyNodeVisitor(Writer writer)
      Parameters:
      writer - Writer
      Returns:
      DependencyNodeVisitor