Package org.machanism.machai.project.layout

Class MavenProjectLayout

java.lang.Object

org.machanism.machai.project.layout.ProjectLayout

org.machanism.machai.project.layout.MavenProjectLayout

public class MavenProjectLayout
extends ProjectLayout

A Maven-specific implementation for project layout.

Supports detection of modules, sources, documents, and tests within Maven projects by parsing pom.xml and its effective model.

Since:

0.0.2

Author:

Viktor Tovstyi

See Also:

• PomReader

Field Summary

Fields inherited from class org.machanism.machai.project.layout.ProjectLayout

EXCLUDE_DIRS

Constructor Summary

Constructors

Constructor	Description
MavenProjectLayout()

Method Summary

Modifier and Type	Method	Description
MavenProjectLayout	effectivePomRequired(boolean effectivePomRequired)	Enables/disables effective POM calculation for module resolution.
List<String>	getDocuments()	Returns a list of documentation sources for Maven projects.
org.apache.maven.model.Model	getModel()	Returns the current Maven Model (parsed pom.xml).
List<String>	getModules()	Returns a list of modules for Maven projects if packaging is pom.
List<String>	getSources()	Returns a list of source directories by inspecting the Maven build section.
List<String>	getTests()	Returns a list of test directories by inspecting the Maven build section.
static boolean	isMavenProject(File projectDir)	Checks if the given directory is a Maven project by looking for pom.xml.
MavenProjectLayout	model(org.apache.maven.model.Model model)	Sets the Maven Model for chaining configuration.

Methods inherited from class org.machanism.machai.project.layout.ProjectLayout

getProjectDir, getRelatedPath, getRelatedPath, getRelatedPath, projectDir

Methods inherited from class java.lang.Object

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

Constructor Details

MavenProjectLayout

public MavenProjectLayout()

Method Details

isMavenProject

public static boolean isMavenProject(File projectDir)

Checks if the given directory is a Maven project by looking for pom.xml.

Parameters:

projectDir - The directory to check

Returns:

true if pom.xml exists; false otherwise

getModules

public List<String> getModules()

Returns a list of modules for Maven projects if packaging is pom.

Overrides:

getModules in class ProjectLayout

Returns:

List of module names, or null if not a multi-module Maven project

See Also:

• PomReader.getProjectModel(File, boolean)

getModel

public org.apache.maven.model.Model getModel()

Returns the current Maven Model (parsed pom.xml).

Returns:

Parsed Maven Model for this project

See Also:

• PomReader.getProjectModel(File)

model

public MavenProjectLayout model(org.apache.maven.model.Model model)

Sets the Maven Model for chaining configuration.

Parameters:

model - The model to set

Returns:

this object (for method chaining)

effectivePomRequired

public MavenProjectLayout effectivePomRequired(boolean effectivePomRequired)

Enables/disables effective POM calculation for module resolution.

Parameters:

effectivePomRequired - true to enable, false otherwise

Returns:

this object (for method chaining)

getSources

public List<String> getSources()

Returns a list of source directories by inspecting the Maven build section.

Specified by:

getSources in class ProjectLayout

Returns:

List of source directories defined in Maven pom.xml

 Example usage:
 MavenProjectLayout layout = new MavenProjectLayout();
 List sources = layout.projectDir(new File("/repo")).getSources();
 

getDocuments

public List<String> getDocuments()

Returns a list of documentation sources for Maven projects.

Specified by:

getDocuments in class ProjectLayout

Returns:

List of documentation sources (default: src/site)

getTests

public List<String> getTests()

Returns a list of test directories by inspecting the Maven build section.

Specified by:

getTests in class ProjectLayout

Returns:

List of test source directories defined in Maven pom.xml