org.springframework.roo.project
Interface ProjectOperations

All Known Implementing Classes:

AbstractProjectOperations

public interface ProjectOperations

Method Summary

void	addBuildPlugin(Plugin plugin) Allows addition of a build plugin to the POM.
void	addDependency(Dependency dependency) Allows addition of a JAR dependency to the POM.
void	addDependency(org.springframework.roo.model.JavaPackage groupId, org.springframework.roo.model.JavaSymbolName artifactId, String version) Allows addition of a JAR dependency to the POM.
void	addDependencyListener(DependencyListener listener) Register a listener to track changes in build dependencies
void	addPluginListener(PluginListener listener) Register a listener to track changes in build plugins
void	addPluginRepository(Repository repository) Allows addition of a plugin repository to the POM.
void	addPluginRepositoryListener(RepositoryListener listener) Register a listener to track changes in plugin repositories
void	addProperty(Property property) Allows addition of a property to the POM.
void	addPropertyListener(PropertyListener listener) Register a listener to track changes in pom properties
void	addRepository(Repository repository) Allows addition of a repository to the POM.
void	addRepositoryListener(RepositoryListener listener) Register a listener to track changes in repositories
void	buildPluginUpdate(Plugin buildPlugin) Verifies if the specified build plugin is present.
void	dependencyUpdate(Dependency dependency) Verifies if the specified dependency is present.
boolean	isDependencyModificationAllowed()
boolean	isPerformCommandAllowed()
void	removeBuildPlugin(Plugin plugin) Allows remove of an existing build plugin from the POM.
void	removeDependency(Dependency dependency) Allows removal of a JAR dependency to the POM.
void	removeDependency(org.springframework.roo.model.JavaPackage groupId, org.springframework.roo.model.JavaSymbolName artifactId, String version) Allows remove of an existing JAR dependency from the POM.
void	removeDependencyListener(DependencyListener listener) Remove a dependency listener from change tracking
void	removePluginListener(PluginListener listener) Remove a build plugin listener from change tracking
void	removePluginRepository(Repository repository) Allows remove of an existing plugin repository from the POM.
void	removePluginRepositoryListener(RepositoryListener listener) Remove a plugin repository listener from change tracking
void	removeProperty(Property property) Allows remove of an existing property from the POM.
void	removePropertyListener(PropertyListener listener) Remove a property listener from change tracking
void	removeRepository(Repository repository) Allows remove of an existing repository from the POM.
void	removeRepositoryListener(RepositoryListener listener) Remove a repository listener from change tracking
void	updateProjectType(ProjectType projectType)

Method Detail

isDependencyModificationAllowed

boolean isDependencyModificationAllowed()

isPerformCommandAllowed

boolean isPerformCommandAllowed()

addDependencyListener

void addDependencyListener(DependencyListener listener)

Register a listener to track changes in build dependencies

removeDependencyListener

void removeDependencyListener(DependencyListener listener)

Remove a dependency listener from change tracking

addRepositoryListener

void addRepositoryListener(RepositoryListener listener)

Register a listener to track changes in repositories

removeRepositoryListener

void removeRepositoryListener(RepositoryListener listener)

Remove a repository listener from change tracking

addPluginRepositoryListener

void addPluginRepositoryListener(RepositoryListener listener)

Register a listener to track changes in plugin repositories

removePluginRepositoryListener

void removePluginRepositoryListener(RepositoryListener listener)

Remove a plugin repository listener from change tracking

addPluginListener

void addPluginListener(PluginListener listener)

Register a listener to track changes in build plugins

removePluginListener

void removePluginListener(PluginListener listener)

Remove a build plugin listener from change tracking

addPropertyListener

void addPropertyListener(PropertyListener listener)

Register a listener to track changes in pom properties

removePropertyListener

void removePropertyListener(PropertyListener listener)

Remove a property listener from change tracking

updateProjectType

void updateProjectType(ProjectType projectType)

addDependency

void addDependency(Dependency dependency)

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.

Parameters:

dependency - to add (required)

addDependency

void addDependency(org.springframework.roo.model.JavaPackage groupId,
                   org.springframework.roo.model.JavaSymbolName 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.

Parameters:

groupId - to add (required)

artifactId - to add (required)

version - to add (required)

removeDependency

void removeDependency(Dependency dependency)

Allows removal of a JAR dependency to 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:

dependency - to remove (required)

removeDependency

void removeDependency(org.springframework.roo.model.JavaPackage groupId,
                      org.springframework.roo.model.JavaSymbolName 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:

groupId - to remove (required)

artifactId - to remove (required)

version - to remove (required)

dependencyUpdate

void dependencyUpdate(Dependency dependency)

Verifies if the specified dependency is present. If it is present, silently returns. If it is not present, removes any dependency which matches ProjectMetadata.getDependenciesExcludingVersion(Dependency). Always adds the presented dependency.

Parameters:

dependency - to add (required)

addRepository

void addRepository(Repository repository)

Allows addition of a repository 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.

Parameters:

repository - to add (required)

removeRepository

void removeRepository(Repository repository)

Allows remove of an existing repository from the POM.

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

Parameters:

repository - to remove (required)

addPluginRepository

void addPluginRepository(Repository repository)

Allows addition of a plugin repository 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.

Parameters:

repository - to add (required)

removePluginRepository

void removePluginRepository(Repository repository)

Allows remove of an existing plugin repository from the POM.

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

Parameters:

plugin - repository to remove (required)

addBuildPlugin

void addBuildPlugin(Plugin plugin)

Allows addition of a build plugin to the POM.

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

Parameters:

plugin - to add (required)

removeBuildPlugin

void removeBuildPlugin(Plugin plugin)

Allows remove of an existing build plugin from the POM.

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

Parameters:

plugin - to add (required)

buildPluginUpdate

void buildPluginUpdate(Plugin buildPlugin)

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:

plugin - to remove (required)

addProperty

void addProperty(Property property)

Allows addition of a property 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.

Parameters:

property - to add (required)

removeProperty

void removeProperty(Property property)

Allows remove of an existing property from the POM.

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

Parameters:

property - to remove (required)