org.springframework.roo.project

Interface ProjectOperations

All Known Subinterfaces:

MavenOperations

All Known Implementing Classes:

AbstractProjectOperations, MavenOperationsImpl

public interface ProjectOperations

Methods for various project-related operations.

Since:

1.0

Author:

Ben Alex, Paula Navarro, Juan Carlos García

Method Summary

Modifier and Type	Method and Description
void	addBuildPlugin(String moduleName, Plugin plugin) Attempts to add the specified build plugin.
void	addBuildPlugin(String moduleName, Plugin plugin, boolean addToPluginManagement) Attempts to add the specified build plugin.
void	addBuildPlugins(String moduleName, Collection<? extends Plugin> plugins) Attempts to add the specified plugins.
void	addBuildPlugins(String moduleName, Collection<? extends Plugin> plugins, boolean addToPluginManagement) Attempts to add the specified plugins.
List<Dependency>	addDependencies(String moduleName, Collection<? extends Dependency> dependencies) Attempts to add the specified dependencies.
List<Dependency>	addDependencies(String moduleName, Collection<? extends Dependency> dependencies, boolean addToDependencyManagement, boolean checkFullDependency) Attempts to add the specified dependencies.
Dependency	addDependency(String moduleName, Dependency dependency) Attempts to add the specified dependency.
Dependency	addDependency(String moduleName, Dependency dependency, boolean addToDependencyManagement) Attempts to add the specified dependency.
Dependency	addDependency(String moduleName, Dependency dependency, boolean addToDependencyManagement, boolean checkFullDependency) Attempts to add the specified dependency.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version) Allows addition of a JAR dependency to the POM.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version, boolean addToDependencyManagement) Allows addition of a JAR dependency to the POM.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version, DependencyScope scope) Allows addition of a JAR dependency to the POM.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version, DependencyScope scope, boolean addToDependencyManagement) Allows addition of a JAR dependency to the POM.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version, DependencyScope scope, String classifier) Allows addition of a JAR dependency to the POM.
Dependency	addDependency(String moduleName, String groupId, String artifactId, String version, DependencyScope scope, String classifier, boolean addToDependencyManagement) Allows addition of a JAR dependency to the POM.
void	addElementToPluginExecution(String moduleName, Plugin plugin, String executionId, String parentElementName, String elementName, Map<String,String> elementValues) Attempts to add the specified element into the specified plugin execution.
void	addElementToPluginExecution(String moduleName, Plugin plugin, String executionId, String parentElementName, String elementName, Map<String,String> elementValues, boolean addToPluginManagement) Attempts to add the specified element into the specified plugin execution.
void	addElementToPluginExecution(String moduleName, Plugin plugin, String executionId, String parentElementName, String elementName, String elementValue) Attempts to add the specified element into the specified plugin execution.
void	addElementToPluginExecution(String moduleName, Plugin plugin, String executionId, String parentElementName, String elementName, String elementValue, boolean addToPluginManagement) Attempts to add the specified element into the specified plugin execution.
void	addFilter(String moduleName, Filter filter) Attempts to add the specified filter.
void	addModuleDependency(String moduleToDependUpon) Adds the given module as a dependency of the currently focused module.
void	addModuleDependency(String moduleName, String moduleToDependUpon) Adds to the given module the dependency with a module.
void	addModuleDependency(String moduleName, String moduleToDependUpon, boolean testDependency) Adds to the given module the dependency with a module and with the possibility of adding it only with test scope and type.
void	addPackageToPluginExecution(String moduleName, Plugin plugin, String executionId, String packageName) Attempts to add the specified package into the specified plugin execution.
void	addPackageToPluginExecution(String moduleName, Plugin plugin, String executionId, String packageName, boolean addToPluginManagement) Attempts to add the specified package into the specified plugin execution.
void	addPluginRepositories(String moduleName, Collection<? extends Repository> repositories) Attempts to add the specified plugin repositories.
void	addPluginRepository(String moduleName, Repository repository) Attempts to add the specified plugin repository.
void	addProperty(String moduleName, Property property) Attempts to add the specified property.
void	addRepositories(String moduleName, Collection<? extends Repository> repositories) Attempts to add the specified repositories.
void	addRepository(String moduleName, Repository repository) Attempts to add the specified repository.
void	addResource(String moduleName, Resource resource) Attempts to add the specified resource.
Pom	getFocusedModule() Returns the Pom of the currently focussed module, or if no module has the focus, the root Pom.
String	getFocusedModuleName() Returns the name of the currently focussed module.
ProjectMetadata	getFocusedProjectMetadata() Returns the metadata for the currently focussed module.
String	getFocusedProjectName()
org.springframework.roo.model.JavaPackage	getFocusedTopLevelPackage()
Pom	getModuleForFileIdentifier(String fileIdentifier) Returns the module to which the given file belongs
Collection<String>	getModuleNames() Returns the names of each module in the user's project
PathResolver	getPathResolver() Convenience method to return the PathResolver from the project's ProjectMetadata.
Pom	getPomFromModuleName(String moduleName) Returns the given module's Pom
Collection<Pom>	getPoms() Returns the Poms for all modules of the user's project
ProjectMetadata	getProjectMetadata(String moduleName) Returns the ProjectMetadata for the given module.
String	getProjectName(String moduleName)
org.springframework.roo.model.JavaPackage	getTopLevelPackage(String moduleName)
boolean	isFeatureInstalled(Pom module, String featureName) Indicates whether any of the supplied features are installed in the provided module.
boolean	isFeatureInstalled(String... featureNames) Indicates whether any of the supplied features are installed in any module of a project.
boolean	isFeatureInstalled(String featureName) Indicates whether the supplied feature is installed in any module of a project.
boolean	isFocusedProjectAvailable() Indicates whether the module whose name has the focus, if any, is available.
boolean	isModuleCreationAllowed() Indicates whether the user can create a new project module
boolean	isModuleFocusAllowed() Indicates whether the user can change the focused module
boolean	isMultimoduleProject() Indicates whether the project is multimodule
boolean	isProjectAvailable(String moduleName) Indicates whether a module with the given name is available.
void	removeBuildPlugin(String moduleName, Plugin plugin) Removes any plugins with the same groupId and artifactId as the given plugin.
void	removeBuildPluginImmediately(String moduleName, Plugin plugin) Removes any plugins with the same groupId and artifactId as the given plugin and immediately writes the pom to the file system.
void	removeBuildPlugins(String moduleName, Collection<? extends Plugin> plugins) Removes any plugins with the same groupId and artifactId as any of the given plugins.
void	removeDependencies(String moduleName, Collection<? extends Dependency> dependencies) Attempts to remove the specified dependencies.
void	removeDependency(String moduleName, Dependency dependency) Attempts to remove the specified dependency.
void	removeDependency(String moduleName, String groupId, String artifactId, String version) Allows remove of an existing JAR dependency from the POM.
void	removeDependency(String moduleName, String groupId, String artifactId, String version, String classifier) Allows remove of an existing JAR dependency from the POM.
void	removeFilter(String moduleName, Filter filter) Attempts to remove the specified filter.
void	removePluginRepository(String moduleName, Repository repository) Attempts to remove the specified plugin repository.
void	removeProperty(String moduleName, Property property) Attempts to remove the specified property dependency.
void	removeRepository(String moduleName, Repository repository) Attempts to remove the specified repository.
void	removeResource(String moduleName, Resource resource) Attempts to remove the specified resource.
void	setModule(Pom module) Sets the currently focused module
void	updateBuildPlugin(String moduleName, Plugin plugin) Verifies if the specified build plugin is present.
void	updateDependencyScope(String moduleName, Dependency dependency, DependencyScope dependencyScope) Attempts to update the scope of the specified dependency.
void	updateProjectType(String moduleName, ProjectType projectType) Attempts to update the project packaging type as defined via ProjectType.

Method Detail

addBuildPlugin

void addBuildPlugin(String moduleName,
                    Plugin plugin)

Attempts to add the specified build plugin. If the plugin already exists according to ProjectMetadata#isBuildPluginRegistered(org.springframework.roo.project.Plugin) , the method silently returns. Otherwise the plugin is added.

By default, includes the provided plugin into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin to add (required)

addBuildPlugin

void addBuildPlugin(String moduleName,
                    Plugin plugin,
                    boolean addToPluginManagement)

Attempts to add the specified build plugin. If the plugin already exists according to ProjectMetadata#isBuildPluginRegistered(org.springframework.roo.project.Plugin) , the method silently returns. Otherwise the plugin is added.

If addToPluginManagement parameter has true value, the new plugin will be included into pluginManagement element. If false, the provided plugin will be included only as plugin.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

addToPluginManagement - boolean that indicates if the new Plugin should be included into pluginManagement element or not.

plugin - the plugin to add (required)

addBuildPlugins

void addBuildPlugins(String moduleName,
                     Collection<? extends Plugin> plugins)

Attempts to add the specified plugins. If all the plugins already exist according to ProjectMetadata#isAllPluginRegistered(Plugin), the method silently returns. Otherwise each new dependency is added.

By default, includes the provided plugin into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugins - the plugins to add (required)

addBuildPlugins

void addBuildPlugins(String moduleName,
                     Collection<? extends Plugin> plugins,
                     boolean addToPluginManagement)

Attempts to add the specified plugins. If all the plugins already exist according to ProjectMetadata#isAllPluginRegistered(Plugin), the method silently returns. Otherwise each new dependency is added.

If addToPluginManagement parameter has true value, the new plugin will be included into pluginManagement element. If false, the provided plugin will be included only as plugin.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

addToPluginManagement - boolean that indicates if the new Plugin should be included into pluginManagement element or not.

plugins - the plugins to add (required)

addPackageToPluginExecution

void addPackageToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String packageName)

Attempts to add the specified package into the specified plugin execution. If the package already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the package is added.

By default, includes the provided package into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

packageName - the package to add (required)

addPackageToPluginExecution

void addPackageToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String packageName,
                                 boolean addToPluginManagement)

Attempts to add the specified package into the specified plugin execution. If the package already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the package is added.

If addToPluginManagement parameter has true value, the new plugin will be included into pluginManagement element. If false, the provided plugin will be included only as plugin.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

packageName - the package to add (required)

addToPluginManagement - boolean that indicates if the new Plugin should be included into pluginManagement element or not.

addElementToPluginExecution

void addElementToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String parentElementName,
                                 String elementName,
                                 String elementValue)

Attempts to add the specified element into the specified plugin execution. If the element already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the element is added.

By default, includes the provided element into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

parentElementName - the parentElement name that should be included inside configuration element

elementName - the element name that should be included inside the parentElementName provided before

elementValue - the value to add (required)

addElementToPluginExecution

void addElementToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String parentElementName,
                                 String elementName,
                                 String elementValue,
                                 boolean addToPluginManagement)

Attempts to add the specified element into the specified plugin execution. If the element already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the element is added.

By default, includes the provided element into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

parentElementName - the parentElement name that should be included inside configuration element

elementName - the element name that should be included inside the parentElementName provided before

elementValue - the value to add (required)

addToPluginManagement - boolean that indicates if the new element should be included into pluginManagement element or not.

addElementToPluginExecution

void addElementToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String parentElementName,
                                 String elementName,
                                 Map<String,String> elementValues)

Attempts to add the specified element into the specified plugin execution. If the element already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the element is added.

By default, includes the provided element into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

parentElementName - the parentElement name that should be included inside configuration element

elementName - the element name that should be included inside the parentElementName provided before

elementValues - the values to add (required)

addElementToPluginExecution

void addElementToPluginExecution(String moduleName,
                                 Plugin plugin,
                                 String executionId,
                                 String parentElementName,
                                 String elementName,
                                 Map<String,String> elementValues,
                                 boolean addToPluginManagement)

Attempts to add the specified element into the specified plugin execution. If the element already exists or the execution does not exist in the specified plugin, the method silently returns. Otherwise the element is added.

By default, includes the provided element into pluginManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin where add the package (required)

executionId - the id of the plugin execution where add the package (required)

parentElementName - the parentElement name that should be included inside configuration element

elementName - the element name that should be included inside the parentElementName provided before

elementValues - the values to add (required)

addToPluginManagement - boolean that indicates if the new element should be included into pluginManagement element or not.

addDependencies

List<Dependency> addDependencies(String moduleName,
                                 Collection<? extends Dependency> dependencies)

Attempts to add the specified dependencies. If all the dependencies already exist according to ProjectMetadata#isAllDependencyRegistered(Dependency), the method silently returns. Otherwise each new dependency is added.

By default, includes the provided dependencies into dependencyManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependencies - the dependencies to add (required)

Returns:

List of dependencies added on current operation

addDependencies

List<Dependency> addDependencies(String moduleName,
                                 Collection<? extends Dependency> dependencies,
                                 boolean addToDependencyManagement,
                                 boolean checkFullDependency)

Attempts to add the specified dependencies. If all the dependencies already exist according to ProjectMetadata#isAllDependencyRegistered(Dependency), the method silently returns. Otherwise each new dependency is added.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependencies - the dependencies to add (required)

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

checkFullDependency - whether should check the existence with full dependency element or only compare 'artifactId' and 'groupId'.

Returns:

List of dependencies added on current operation

addDependency

Dependency addDependency(String moduleName,
                         Dependency dependency)

Attempts to add the specified dependency. If the dependency already exists according to to ProjectMetadata#isDependencyRegistered(org.springframework.roo.project.Dependency) , the method silently returns. Otherwise the dependency is added.

By default, includes the provided dependency into dependencyManagement element.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependency - the dependency to add (required)

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         Dependency dependency,
                         boolean addToDependencyManagement)

Attempts to add the specified dependency. If the dependency already exists according to to ProjectMetadata#isDependencyRegistered(org.springframework.roo.project.Dependency) , the method silently returns. Otherwise the dependency is added.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependency - the dependency to add (required)

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         Dependency dependency,
                         boolean addToDependencyManagement,
                         boolean checkFullDependency)

Attempts to add the specified dependency. If the dependency already exists according to to ProjectMetadata#isDependencyRegistered(org.springframework.roo.project.Dependency) , the method silently returns. Otherwise the dependency is added.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependency - the dependency to add (required)

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

checkFullDependency - whether should check the existence with full dependency element or only compare 'artifactId' and 'groupId'.

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

By default, includes the provided dependency into dependencyManagement element.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version,
                         boolean addToDependencyManagement)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version,
                         DependencyScope scope)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

By default, includes the provided dependency into dependencyManagement element.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

scope - the scope of the dependency

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version,
                         DependencyScope scope,
                         boolean addToDependencyManagement)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

scope - the scope of the dependency

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version,
                         DependencyScope scope,
                         String classifier)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

By default, includes the provided dependency into dependencyManagement element.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

scope - the scope of the dependency

classifier - the classifier of the dependency

Returns:

added dependency

addDependency

Dependency addDependency(String moduleName,
                         String groupId,
                         String artifactId,
                         String version,
                         DependencyScope scope,
                         String classifier,
                         boolean addToDependencyManagement)

Allows addition of a JAR dependency to the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to add support for their projects without requiring the user to manually edit a pom.xml or write an add-on.

If addToDependencyManagement parameter has true value, the new dependency will be included into dependencyManagement element. If false, the provided dependency will be included only as dependency.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

scope - the scope of the dependency

classifier - the classifier of the dependency

addToDependencyManagement - boolean that indicates if the new Dependency should be included into dependencyManagement element or not.

Returns:

added dependency

addFilter

void addFilter(String moduleName,
               Filter filter)

Attempts to add the specified filter. If the filter already exists according to ProjectMetadata#isFilterRegistered(org.springframework.roo.project.Filter) , the method silently returns. Otherwise the filter is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

filter - the filter to add (required)

addModuleDependency

void addModuleDependency(String moduleToDependUpon)

Adds the given module as a dependency of the currently focused module.

Parameters:

moduleToDependUpon - the name of the module to act upon (required)

addModuleDependency

void addModuleDependency(String moduleName,
                         String moduleToDependUpon)

Adds to the given module the dependency with a module.

Parameters:

moduleName - the name of the module where to install the dependency (required)

moduleToDependUpon - the name of the module to act upon (required)

addModuleDependency

void addModuleDependency(String moduleName,
                         String moduleToDependUpon,
                         boolean testDependency)

Adds to the given module the dependency with a module and with the possibility of adding it only with test scope and type.

Parameters:

moduleName - the name of the module where to install the dependency (required)

moduleToDependUpon - the name of the module to act upon (required)

testDependency - whether the module dependency should be added with test scope and as test type dependency.

addPluginRepositories

void addPluginRepositories(String moduleName,
                           Collection<? extends Repository> repositories)

Attempts to add the specified plugin repositories. If all the repositories already exists according to ProjectMetadata#isPluginRepositoryRegistered(Repository), the method silently returns. Otherwise each new repository is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repositories - a list of plugin repositories to add (required)

addPluginRepository

void addPluginRepository(String moduleName,
                         Repository repository)

Attempts to add the specified plugin repository. If the plugin repository already exists according to ProjectMetadata#isPluginRepositoryRegistered(Repository), the method silently returns. Otherwise the repository is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repository - the plugin repository to add (required)

addProperty

void addProperty(String moduleName,
                 Property property)

Attempts to add the specified property. If the property already exists according to ProjectMetadata#isPropertyRegistered(org.springframework.roo.project.Property) , the method silently returns. Otherwise the property is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

property - the property to add (required)

addRepositories

void addRepositories(String moduleName,
                     Collection<? extends Repository> repositories)

Attempts to add the specified repositories. If all the repositories already exists according to ProjectMetadata#isRepositoryRegistered(Repository), the method silently returns. Otherwise each new repository is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repositories - a list of repositories to add (required)

addRepository

void addRepository(String moduleName,
                   Repository repository)

Attempts to add the specified repository. If the repository already exists according to ProjectMetadata#isRepositoryRegistered(Repository), the method silently returns. Otherwise the repository is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repository - the repository to add (required)

addResource

void addResource(String moduleName,
                 Resource resource)

Attempts to add the specified resource. If the resource already exists according to ProjectMetadata#isResourceRegistered(Resource), the method silently returns. Otherwise the resource is added.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

resource - the resource to add (required)

getFocusedModule

Pom getFocusedModule()

Returns the Pom of the currently focussed module, or if no module has the focus, the root Pom.

Returns:

null if none of the above descriptors exist

getFocusedModuleName

String getFocusedModuleName()

Returns the name of the currently focussed module.

Returns:

an empty string if no module has the focus, otherwise a fully-qualified name separated by File.separator

getFocusedProjectMetadata

ProjectMetadata getFocusedProjectMetadata()

Returns the metadata for the currently focussed module.

Returns:

null if no project metadata is available

getFocusedProjectName

String getFocusedProjectName()

Returns:

getFocusedTopLevelPackage

org.springframework.roo.model.JavaPackage getFocusedTopLevelPackage()

Returns:

getModuleForFileIdentifier

Pom getModuleForFileIdentifier(String fileIdentifier)

Returns the module to which the given file belongs

Parameters:

fileIdentifier - the canonical path to look up

Returns:

see above

getModuleNames

Collection<String> getModuleNames()

Returns the names of each module in the user's project

Returns:

a non-null list

getPathResolver

PathResolver getPathResolver()

Convenience method to return the PathResolver from the project's ProjectMetadata.

Returns:

the PathResolver, or null if the project is unavailable

getPomFromModuleName

Pom getPomFromModuleName(String moduleName)

Returns the given module's Pom

Parameters:

moduleName - the fully-qualified name of the module (required)

Returns:

getPoms

Collection<Pom> getPoms()

Returns the Poms for all modules of the user's project

Returns:

a non-null collection

getProjectMetadata

ProjectMetadata getProjectMetadata(String moduleName)

Returns the ProjectMetadata for the given module.

Parameters:

moduleName - the module whose metadata is being requested (can be empty to signify the root or only module)

Returns:

null if the metadata is not available

getProjectName

String getProjectName(String moduleName)

Parameters:

moduleName - the name of the module to act upon (required)

Returns:

getTopLevelPackage

org.springframework.roo.model.JavaPackage getTopLevelPackage(String moduleName)

Parameters:

moduleName - the name of the module to act upon (required)

Returns:

isFeatureInstalled

boolean isFeatureInstalled(String featureName)

Indicates whether the supplied feature is installed in any module of a project.

Parameters:

featureName - the name of the feature (see FeatureNames for available features)

Returns:

true if the feature is installed in any module, otherwise false

isFeatureInstalled

boolean isFeatureInstalled(String... featureNames)

Indicates whether any of the supplied features are installed in any module of a project.

Parameters:

featureNames - the names of the features (see FeatureNames for available features)

Returns:

true if any of the supplied features are installed in the focused module, otherwise false

isFeatureInstalled

boolean isFeatureInstalled(Pom module,
                           String featureName)

Indicates whether any of the supplied features are installed in the provided module.

Parameters:

module - the Pom where to search the feature.

featureName - the names of the feature (see FeatureNames for available features)

Returns:

`true` if the supplied feature is installed in the provided module, otherwise `false`.

isFocusedProjectAvailable

boolean isFocusedProjectAvailable()

Indicates whether the module whose name has the focus, if any, is available.

Returns:

see above

isModuleCreationAllowed

boolean isModuleCreationAllowed()

Indicates whether the user can create a new project module

Returns:

see above

isModuleFocusAllowed

boolean isModuleFocusAllowed()

Indicates whether the user can change the focused module

Returns:

see above

isMultimoduleProject

boolean isMultimoduleProject()

Indicates whether the project is multimodule

Returns:

see above

isProjectAvailable

boolean isProjectAvailable(String moduleName)

Indicates whether a module with the given name is available.

Parameters:

moduleName - the name of the module to act upon (can be blank)

Returns:

see above

removeBuildPlugin

void removeBuildPlugin(String moduleName,
                       Plugin plugin)

Removes any plugins with the same groupId and artifactId as the given plugin.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin to remove (can be null)

Throws:

IllegalArgumentException - if this method is called before the ProjectMetadata is available, or if the on-disk representation cannot be modified for any reason

removeBuildPluginImmediately

void removeBuildPluginImmediately(String moduleName,
                                  Plugin plugin)

Removes any plugins with the same groupId and artifactId as the given plugin and immediately writes the pom to the file system.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the plugin to remove (can be null)

Throws:

IllegalArgumentException - if this method is called before the ProjectMetadata is available, or if the on-disk representation cannot be modified for any reason

removeBuildPlugins

void removeBuildPlugins(String moduleName,
                        Collection<? extends Plugin> plugins)

Removes any plugins with the same groupId and artifactId as any of the given plugins.

Parameters:

moduleName - the name of the module to act upon (required)

plugins - the plugins to remove; can be null, any null elements will be quietly ignored

Throws:

IllegalArgumentException - if this method is called before the ProjectMetadata is available, or if the on-disk representation cannot be modified for any reason

removeDependencies

void removeDependencies(String moduleName,
                        Collection<? extends Dependency> dependencies)

Attempts to remove the specified dependencies. If all the dependencies do not exist according to ProjectMetadata#isDependencyRegistered(Dependency), the method silently returns. Otherwise each located dependency is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependencies - the dependencies to remove (required)

removeDependency

void removeDependency(String moduleName,
                      Dependency dependency)

Attempts to remove the specified dependency. If the dependency does not exist according to ProjectMetadata#isDependencyRegistered(Dependency), the method silently returns. Otherwise the located dependency is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependency - the dependency to remove (required)

removeDependency

void removeDependency(String moduleName,
                      String groupId,
                      String artifactId,
                      String version)

Allows remove of an existing JAR dependency from the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to remove an unwanted dependency from their projects without requiring the user to manually edit a pom.xml or write an add-on.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

removeDependency

void removeDependency(String moduleName,
                      String groupId,
                      String artifactId,
                      String version,
                      String classifier)

Allows remove of an existing JAR dependency from the POM.

Provides a convenient way for third parties to instruct end users how to use the CLI to remove an unwanted dependency from their projects without requiring the user to manually edit a pom.xml or write an add-on.

Parameters:

moduleName - the name of the module to act upon (required)

groupId - the group id of the dependency (required)

artifactId - the artifact id of the dependency (required)

version - the version of the dependency (required)

classifier - the classifier of the dependency

removeFilter

void removeFilter(String moduleName,
                  Filter filter)

Attempts to remove the specified filter. If the filter does not exist according to ProjectMetadata#isFilterRegistered(org.springframework.roo.project.Filter) , the method silently returns. Otherwise the located filter is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

filter - the filter to remove (required)

removePluginRepository

void removePluginRepository(String moduleName,
                            Repository repository)

Attempts to remove the specified plugin repository. If the plugin repository does not exist according to ProjectMetadata#isPluginRepositoryRegistered(Repository), the method silently returns. Otherwise the located plugin repository is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repository - the plugin repository to remove (required)

removeProperty

void removeProperty(String moduleName,
                    Property property)

Attempts to remove the specified property dependency. If the dependency does not exist according to ProjectMetadata#isPropertyRegistered(Property), the method silently returns. Otherwise the located dependency is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

property - the property to remove (required)

removeRepository

void removeRepository(String moduleName,
                      Repository repository)

Attempts to remove the specified repository. If the repository does not exist according to ProjectMetadata#isRepositoryRegistered(Repository), the method silently returns. Otherwise the located repository is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

repository - the repository to remove (required)

removeResource

void removeResource(String moduleName,
                    Resource resource)

Attempts to remove the specified resource. If the resource does not exist according to ProjectMetadata#isResourceRegistered(Resource), the method silently returns. Otherwise the located resource is removed.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

resource - the resource to remove (required)

setModule

void setModule(Pom module)

Sets the currently focused module

Parameters:

module - the module to focus upon (required)

updateBuildPlugin

void updateBuildPlugin(String moduleName,
                       Plugin plugin)

Verifies if the specified build plugin is present. If it is present, silently returns. If it is not present, removes any build plugin which matches ProjectMetadata#getBuildPluginsExcludingVersion(Plugin). Always adds the presented plugin.

Parameters:

moduleName - the name of the module to act upon (required)

plugin - the build plugin to update (required)

updateDependencyScope

void updateDependencyScope(String moduleName,
                           Dependency dependency,
                           DependencyScope dependencyScope)

Attempts to update the scope of the specified dependency. If the dependency does not exist according to ProjectMetadata#isDependencyRegistered(Dependency), the method silently returns. Otherwise the located dependency is updated.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

dependency - the dependency to update (required)

dependencyScope - the dependency scope. May be null, in which case the element will be removed

updateProjectType

void updateProjectType(String moduleName,
                       ProjectType projectType)

Attempts to update the project packaging type as defined via ProjectType. If the project packaging is not defined it will create a new definition.

An exception is thrown if this method is called before there is ProjectMetadata available, or if the on-disk representation cannot be modified for any reason.

Parameters:

moduleName - the name of the module to act upon (required)

projectType - the project type to update (required)