Package org.rodnansol.core.project

Class Project

java.lang.Object

org.rodnansol.core.project.Project

Direct Known Subclasses:

GradleProject, MavenProject, SimpleProject

public abstract class Project
extends Object

Class representing a project.

Since:

0.1.0

Author:

nandorholozsnyak

Field Summary

Fields

Modifier and Type	Field	Description
protected File	basedir
protected List<String>	modules
protected String	name
protected ProjectType	projectType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Project(File basedir, String name, ProjectType projectType)

Method Summary

Modifier and Type	Method	Description
File	getBasedir()
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>	getModules()
String	getName()
List<String>	getPossibleMetadataFilePaths()	Returns the list of the possible metadata file paths inside a project.
ProjectType	getProjectType()
void	setModules(List<String> modules)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

basedir

protected final File basedir

name

protected final String name

projectType

protected final ProjectType projectType

modules

protected List<String> modules

Constructor Detail

Project

protected Project(File basedir,
                  String name,
                  ProjectType projectType)

Method Detail

getBasedir

public File getBasedir()

getModules

public List<String> getModules()

setModules

public void setModules(List<String> modules)

getName

public String getName()

getProjectType

public ProjectType getProjectType()

toString

public String toString()

Overrides:

toString in class Object

getDefaultOutputFolder

public String getDefaultOutputFolder(String moduleName)

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

Parameters:

moduleName - module's name.

Returns:

output folder based on the incoming parameters.

getDefaultOutputFolder

public String getDefaultOutputFolder()

Returns the default output folder based on the Project instance.

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

Returns:

output folder based on the incoming parameter.

getDefaultTargetFilePath

public String getDefaultTargetFilePath(TemplateType templateType)

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

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)

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

Parameters:

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

Returns:

target file path based on the incoming parameters.

getPossibleMetadataFilePaths

public List<String> getPossibleMetadataFilePaths()

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

Returns:

list of the possible metadata file paths.