org.springframework.roo.project

Interface MavenOperations

All Superinterfaces:

ProjectOperations

All Known Implementing Classes:

MavenOperationsImpl

public interface MavenOperations
extends ProjectOperations

Provides Maven project operations.

Since:

1.1

Author:

Ben Alex, Paula Navarro

Method Summary

Modifier and Type	Method and Description
void	createModule(String moduleName, PackagingProvider packagingType, String artifactId) Creates a module within an existing Maven project
void	createMultimoduleProject(org.springframework.roo.model.JavaPackage topLevelPackage, String projectName, Integer majorJavaVersion, Multimodule multimodule) Creates a multimodule Maven-based project
void	createProject(org.springframework.roo.model.JavaPackage topLevelPackage, String projectName, Integer majorJavaVersion, PackagingProvider packagingType) Creates a Maven-based project
void	executeMvnCommand(String command) Executes the given Maven command
String	getProjectRoot()
boolean	isCreateProjectAvailable() Indicates whether a new Maven project can be created

Methods inherited from interface org.springframework.roo.project.ProjectOperations

addBuildPlugin, addBuildPlugin, addBuildPlugins, addBuildPlugins, addDependencies, addDependencies, addDependency, addDependency, addDependency, addDependency, addDependency, addDependency, addDependency, addDependency, addDependency, addElementToPluginExecution, addElementToPluginExecution, addElementToPluginExecution, addElementToPluginExecution, addFilter, addModuleDependency, addModuleDependency, addModuleDependency, addPackageToPluginExecution, addPackageToPluginExecution, addPluginRepositories, addPluginRepository, addProperty, addRepositories, addRepository, addResource, getFocusedModule, getFocusedModuleName, getFocusedProjectMetadata, getFocusedProjectName, getFocusedTopLevelPackage, getModuleForFileIdentifier, getModuleNames, getPathResolver, getPomFromModuleName, getPoms, getProjectMetadata, getProjectName, getTopLevelPackage, isFeatureInstalled, isFeatureInstalled, isFeatureInstalled, isFocusedProjectAvailable, isModuleCreationAllowed, isModuleFocusAllowed, isMultimoduleProject, isProjectAvailable, removeBuildPlugin, removeBuildPluginImmediately, removeBuildPlugins, removeDependencies, removeDependency, removeDependency, removeDependency, removeFilter, removePluginRepository, removeProperty, removeRepository, removeResource, setModule, updateBuildPlugin, updateDependencyScope, updateProjectType

Method Detail

createModule

void createModule(String moduleName,
                  PackagingProvider packagingType,
                  String artifactId)

Creates a module within an existing Maven project

Parameters:

moduleName - the name and artifactId of the new module

packagingType - the packaging of the module (can be null to use the default)

artifactId - the artifact ID of the module (defaults to moduleName)

createProject

void createProject(org.springframework.roo.model.JavaPackage topLevelPackage,
                   String projectName,
                   Integer majorJavaVersion,
                   PackagingProvider packagingType)

Creates a Maven-based project

Parameters:

topLevelPackage - the top-level Java package (required)

projectName - the name of the project (can be blank to generate it from the top-level package)

majorJavaVersion - the major Java version to which this project is targetted (can be null to autodetect)

packagingType - the packaging of the project (can be null to use the default)

createMultimoduleProject

void createMultimoduleProject(org.springframework.roo.model.JavaPackage topLevelPackage,
                              String projectName,
                              Integer majorJavaVersion,
                              Multimodule multimodule)

Creates a multimodule Maven-based project

Parameters:

topLevelPackage - the top-level Java package (required)

projectName - the name of the project (can be blank to generate it from the top-level package)

majorJavaVersion - the major Java version to which this project is targetted (can be null to autodetect)

multimodule - the multimodule architecture (required).

executeMvnCommand

void executeMvnCommand(String command)
                throws IOException

Executes the given Maven command

Parameters:

command - the command and any arguments it requires (e.g. "-o clean install")

Throws:

IOException

getProjectRoot

String getProjectRoot()

isCreateProjectAvailable

boolean isCreateProjectAvailable()

Indicates whether a new Maven project can be created

Returns:

see above