com.atlassian.maven.plugins.depgraph

Class DependencyBasedGeneratorMojoParent

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.atlassian.maven.plugins.depgraph.DependencyBasedGeneratorMojoParent

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

GenerateGraphMojo, GenerateJsonMetadataMojo

public abstract class DependencyBasedGeneratorMojoParent
extends org.apache.maven.plugin.AbstractMojo

Base class for all the Mojos that generates a GraphNode map using the Dependency tree lib from Maven. Essentially, it creates a basic behaviour for all the maven goals in this plugin, as they will need to create the graph model in order to do anything else.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder	dependencyGraphBuilder
protected org.apache.maven.project.MavenProject	project
protected List<org.apache.maven.project.MavenProject>	reactorProjects
protected org.apache.maven.execution.MavenSession	session
static List<String>	specialElements This list represents the special libraries that we do not want to expand.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DependencyBasedGeneratorMojoParent()

Method Summary

Modifier and Type	Method and Description
protected GraphNode	buildGraphMapAndReturnRootNodeForProject() Runs all the dependency tree processing (using the dependency tree lib from Maven) and translates it to the model used in this project.
Map<String,GraphNode>	getGraphNodeMap() Returns the graph node map, where: - The key is a String with the graph node's key (pattern GROUPID:ARTIFACTID) - The value is a graph node object

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

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

execute

Field Detail

specialElements

public static List<String> specialElements

This list represents the special libraries that we do not want to expand. This could possibly be a default for a parameter somehow.

dependencyGraphBuilder

@Component(hint="default")
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder dependencyGraphBuilder

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           readonly=true,
           required=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

Constructor Detail

DependencyBasedGeneratorMojoParent

public DependencyBasedGeneratorMojoParent()

Method Detail

buildGraphMapAndReturnRootNodeForProject

protected GraphNode buildGraphMapAndReturnRootNodeForProject()
                                                      throws org.apache.maven.plugin.MojoExecutionException

Runs all the dependency tree processing (using the dependency tree lib from Maven) and translates it to the model used in this project. Returns the root node of the graph that represents the main project in which the mojo was executed

Returns:

graph's root node representation

Throws:

org.apache.maven.plugin.MojoExecutionException

getGraphNodeMap

public Map<String,GraphNode> getGraphNodeMap()

Returns the graph node map, where: - The key is a String with the graph node's key (pattern GROUPID:ARTIFACTID) - The value is a graph node object

Returns:

Graph node map.