Package org.rodnansol.core.project.maven

Class MavenProject

java.lang.Object

org.rodnansol.core.project.Project

org.rodnansol.core.project.maven.MavenProject

public class MavenProject
extends Project

Class representing a Maven project.

Since:

0.1.0

Author:

nandorholozsnyak

Field Summary

Fields inherited from class org.rodnansol.core.project.Project

basedir, modules, name, projectType

Constructor Summary

Constructors

Constructor	Description
MavenProject(File basedir, String name)
MavenProject(File basedir, String name, List<String> modules)

Method Summary

Modifier and Type	Method	Description
String	getDefaultAggregatedTargetFilePath(String extension)	Returns the output file path based on the Project instance and template type value.
String	getDefaultOutputFolder()	Returns the default output folder based on the Project instance.
String	getDefaultOutputFolder(String moduleName)	Returns the default output folder based on the Project instance and module name (in multi-module setup).
String	getDefaultTargetFilePath(TemplateType templateType)	Returns the output file path based on the Project instance and template type value.
List<String>	getPossibleMetadataFilePaths()	Returns the list of the possible metadata file paths inside a project.

Methods inherited from class org.rodnansol.core.project.Project

getBasedir, getModules, getName, getProjectType, setModules, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenProject

public MavenProject(File basedir,
                    String name)

MavenProject

public MavenProject(File basedir,
                    String name,
                    List<String> modules)

Method Detail

getDefaultOutputFolder

public String getDefaultOutputFolder(String moduleName)

Description copied from class: Project

Returns the default output folder based on the Project instance and module name (in multi-module setup).

For example: multi-module-parent/multi-module-a/target/property-docs

Overrides:

getDefaultOutputFolder in class Project

Parameters:

moduleName - module's name.

Returns:

output folder based on the incoming parameters.

getDefaultOutputFolder

public String getDefaultOutputFolder()

Description copied from class: Project

Returns the default output folder based on the Project instance.

For example: module-a/target/property-docs

Overrides:

getDefaultOutputFolder in class Project

Returns:

output folder based on the incoming parameter.

getDefaultTargetFilePath

public String getDefaultTargetFilePath(TemplateType templateType)

Description copied from class: Project

Returns the output file path based on the Project instance and template type value.

For example: multi-module-parent/target/property-docs/multi-module-parent-property-docs-aggregated.md

Overrides:

getDefaultTargetFilePath in class Project

Parameters:

templateType - type of the template, the extension will be determined based on this.

Returns:

target file path based on the project instance and template type.

getDefaultAggregatedTargetFilePath

public String getDefaultAggregatedTargetFilePath(String extension)

Description copied from class: Project

Returns the output file path based on the Project instance and template type value.

For example: module-a/target/property-docs/module-a-property-docs.md

Overrides:

getDefaultAggregatedTargetFilePath in class Project

Parameters:

extension - extension (like .md, .adoc etc)

Returns:

target file path based on the incoming parameters.

getPossibleMetadataFilePaths

public List<String> getPossibleMetadataFilePaths()

Description copied from class: Project

Returns the list of the possible metadata file paths inside a project.

Overrides:

getPossibleMetadataFilePaths in class Project

Returns:

list of the possible metadata file paths.