org.jfrog.build.extractor.maven.reader

Class ProjectReader

java.lang.Object

org.jfrog.build.extractor.maven.reader.ProjectReader

public class ProjectReader
extends java.lang.Object

Read a Maven project recursively.

Constructor Summary

Constructors

Constructor and Description
ProjectReader(java.io.File rootPom) Constructor, gets the file which represents the location of the root pom of the Maven project.

Method Summary

Modifier and Type	Method and Description
java.util.Map<ModuleName,java.io.File>	read() Read the project starting with the root pom.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectReader

public ProjectReader(java.io.File rootPom)

Constructor, gets the file which represents the location of the root pom of the Maven project.

Parameters:

rootPom - The root pom of the Maven project.

Method Detail

read

public java.util.Map<ModuleName,java.io.File> read()
                                            throws java.io.IOException

Read the project starting with the root pom. This method returns a HashMap that has ModuleName as its key, and the location of its corresponding pom file which was used to construct the ModuleName

Returns:

A map of ModuleName and the file that was used to build it.

Throws:

java.io.IOException - Thrown in case of an error occurring while reading the pom.