org.sonar.batch.scan
Class ProjectReactorBuilder

java.lang.Object
  org.sonar.batch.scan.ProjectReactorBuilder

Direct Known Subclasses:

DeprecatedProjectReactorBuilder

public class ProjectReactorBuilder
extends Object

Class that creates a project definition based on a set of properties.

Field Summary

protected static String[]	MANDATORY_PROPERTIES_FOR_CHILD Array of all mandatory properties required for a child project before its properties get merged with its parent ones.
protected static String	PROPERTY_PROJECT_BASEDIR

Constructor Summary

ProjectReactorBuilder(TaskProperties props)

Method Summary

protected static void	checkExistenceOfDirectories(String moduleRef, File baseDir, String[] dirPaths, String propName)
protected static void	checkExistenceOfPaths(String moduleRef, File baseDir, String[] paths, String propName)
protected static void	checkMandatoryProperties(Properties props, String[] mandatoryProps)
protected static void	checkUniquenessOfChildKey(ProjectDefinition childProject, ProjectDefinition parentProject)
protected static void	cleanAndCheckAggregatorProjectProperties(ProjectDefinition project)
protected static void	cleanAndCheckModuleProperties(ProjectDefinition project)
protected static void	cleanAndCheckProjectDefinitions(ProjectDefinition project)
protected ProjectDefinition	defineProject(Properties properties, ProjectDefinition parent)
ProjectReactor	execute()
protected static Properties	extractModuleProperties(String module, Properties properties)
protected static File[]	getLibraries(File baseDir, String pattern) Returns files matching specified pattern.
protected File	initModuleWorkDir(File moduleBaseDir, Properties moduleProperties)
protected File	initRootProjectWorkDir(File baseDir)
protected ProjectDefinition	loadChildProject(ProjectDefinition parentProject, Properties moduleProps, String moduleId)
protected static void	mergeParentProperties(Properties childProps, Properties parentProps)
protected static File	resolvePath(File baseDir, String path)
protected static void	setModuleKeyAndNameIfNotDefined(Properties childProps, String moduleId, String parentKey)
protected static void	setProjectBaseDir(File baseDir, Properties childProps, String moduleId)
protected static Properties	toProperties(File propertyFile)
protected static void	validateDirectories(Properties props, File baseDir, String projectId)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PROJECT_BASEDIR

protected static final String PROPERTY_PROJECT_BASEDIR

See Also:

Constant Field Values

MANDATORY_PROPERTIES_FOR_CHILD

protected static final String[] MANDATORY_PROPERTIES_FOR_CHILD

Array of all mandatory properties required for a child project before its properties get merged with its parent ones.

Constructor Detail

ProjectReactorBuilder

public ProjectReactorBuilder(TaskProperties props)

Method Detail

execute

public ProjectReactor execute()

defineProject

protected ProjectDefinition defineProject(Properties properties,
                                          @Nullable
                                          ProjectDefinition parent)

initRootProjectWorkDir

protected File initRootProjectWorkDir(File baseDir)

initModuleWorkDir

protected File initModuleWorkDir(File moduleBaseDir,
                                 Properties moduleProperties)

loadChildProject

protected ProjectDefinition loadChildProject(ProjectDefinition parentProject,
                                             Properties moduleProps,
                                             String moduleId)

toProperties

protected static Properties toProperties(File propertyFile)

setModuleKeyAndNameIfNotDefined

protected static void setModuleKeyAndNameIfNotDefined(Properties childProps,
                                                      String moduleId,
                                                      String parentKey)

checkUniquenessOfChildKey

protected static void checkUniquenessOfChildKey(ProjectDefinition childProject,
                                                ProjectDefinition parentProject)

setProjectBaseDir

protected static void setProjectBaseDir(File baseDir,
                                        Properties childProps,
                                        String moduleId)

checkMandatoryProperties

protected static void checkMandatoryProperties(Properties props,
                                               String[] mandatoryProps)

validateDirectories

protected static void validateDirectories(Properties props,
                                          File baseDir,
                                          String projectId)

cleanAndCheckProjectDefinitions

protected static void cleanAndCheckProjectDefinitions(ProjectDefinition project)

cleanAndCheckModuleProperties

protected static void cleanAndCheckModuleProperties(ProjectDefinition project)

cleanAndCheckAggregatorProjectProperties

protected static void cleanAndCheckAggregatorProjectProperties(ProjectDefinition project)

mergeParentProperties

protected static void mergeParentProperties(Properties childProps,
                                            Properties parentProps)

extractModuleProperties

protected static Properties extractModuleProperties(String module,
                                                    Properties properties)

checkExistenceOfDirectories

protected static void checkExistenceOfDirectories(String moduleRef,
                                                  File baseDir,
                                                  String[] dirPaths,
                                                  String propName)

checkExistenceOfPaths

protected static void checkExistenceOfPaths(String moduleRef,
                                            File baseDir,
                                            String[] paths,
                                            String propName)

getLibraries

protected static File[] getLibraries(File baseDir,
                                     String pattern)

Returns files matching specified pattern.

resolvePath

protected static File resolvePath(File baseDir,
                                  String path)