com.atlassian.maven.plugins.depgraph.json

Class ProjectDependenciesMetadataJsonBuilder

java.lang.Object

com.atlassian.maven.plugins.depgraph.json.ProjectDependenciesMetadataJsonBuilder

public class ProjectDependenciesMetadataJsonBuilder
extends Object

Creates a full project JSON metadata file with all the dependencies, modules and basic artifact information for every module and dependency of the projects in the reactor, based on a initial state (empty, or a JSON file)

Constructor Summary

Constructors

Constructor and Description
ProjectDependenciesMetadataJsonBuilder()
ProjectDependenciesMetadataJsonBuilder(File initialStateJsonFile)

Method Summary

Modifier and Type	Method and Description
void	evolve(Collection<GraphNode> graphNodes) Evolves the model by adding the necessary new nodes to the internal graph map.
RootNodeJson	getRootNode() Gets the root node for this graph.
void	writeToFile(File fileToWriteTo) Creates the JSON metadata file in the destination specified in the param fileToWriteTo.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectDependenciesMetadataJsonBuilder

public ProjectDependenciesMetadataJsonBuilder()
                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

ProjectDependenciesMetadataJsonBuilder

public ProjectDependenciesMetadataJsonBuilder(File initialStateJsonFile)
                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

Method Detail

evolve

public void evolve(Collection<GraphNode> graphNodes)

Evolves the model by adding the necessary new nodes to the internal graph map.

Parameters:

graphNodes - the nodes that should be part of the graph map. If any of them is already in the map, its information will be merged with the existing values.

getRootNode

public RootNodeJson getRootNode()

Gets the root node for this graph.

Returns:

the root node of the graph.

writeToFile

public void writeToFile(File fileToWriteTo)
                 throws org.apache.maven.plugin.MojoExecutionException

Creates the JSON metadata file in the destination specified in the param fileToWriteTo.

Parameters:

fileToWriteTo - output file destination

Throws:

org.apache.maven.plugin.MojoExecutionException