ProjectMetadataProvider (Spring Roo - Runtime

All Superinterfaces:

org.springframework.roo.metadata.MetadataProvider
```
public interface ProjectMetadataProvider
extends org.springframework.roo.metadata.MetadataProvider
```
Provides mutability services for ProjectMetadata.

Since:

1.0

Author:

Ben Alex, Stefan Schmidt, Alan Stewart

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBuildPlugin(Plugin plugin)` Attempts to add the specified build plugin.
`void`	`addBuildPlugins(Collection<? extends Plugin> plugins)` Attempts to add the specified plugins.
`void`	`addDependencies(Collection<? extends Dependency> dependencies)` Attempts to add the specified dependencies.
`void`	`addDependency(Dependency dependency)` Attempts to add the specified dependency.
`void`	`addFilter(Filter filter)` Attempts to add the specified filter.
`void`	`addPluginRepositories(Collection<? extends Repository> repositories)` Attempts to add the specified plugin repositories.
`void`	`addPluginRepository(Repository repository)` Attempts to add the specified plugin repository.
`void`	`addProperty(Property property)` Attempts to add the specified property.
`void`	`addRepositories(Collection<? extends Repository> repositories)` Attempts to add the specified repositories.
`void`	`addRepository(Repository repository)` Attempts to add the specified repository.
`void`	`addResource(Resource resource)` Attempts to add the specified resource.
`void`	`removeBuildPlugin(Plugin plugin)` Removes any plugins with the same groupId and artifactId as the given plugin.
`void`	`removeBuildPlugins(Collection<? extends Plugin> plugins)` Removes any plugins with the same groupId and artifactId as any of the given plugins.
`void`	`removeDependencies(Collection<? extends Dependency> dependencies)` Attempts to remove the specified dependencies.
`void`	`removeDependency(Dependency dependency)` Attempts to remove the specified dependency.
`void`	`removeFilter(Filter filter)` Attempts to remove the specified filter.
`void`	`removePluginRepository(Repository repository)` Attempts to remove the specified plugin repository.
`void`	`removeProperty(Property property)` Attempts to remove the specified property dependency.
`void`	`removeRepository(Repository repository)` Attempts to remove the specified repository.
`void`	`removeResource(Resource resource)` Attempts to remove the specified resource.
`void`	`updateDependencyScope(Dependency dependency, DependencyScope dependencyScope)` Attempts to update the scope of the specified dependency.
`void`	`updateProjectType(ProjectType projectType)` Attempts to update the project packaging type as defined via `ProjectType`.

Methods inherited from interface org.springframework.roo.metadata.MetadataProvider
get, getProvidesType

- Method Detail
  - addBuildPlugin
```
void addBuildPlugin(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.
    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:
    
    plugin - the plugin to add (required)
  - addBuildPlugins
```
void addBuildPlugins(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.
    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:
    
    plugins - the plugins to add (required)
  - addDependencies
```
void addDependencies(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.
    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:
    
    dependencies - the dependencies to add (required)
  - addDependency
```
void addDependency(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.
    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:
    
    dependency - the dependency to add (required)
  - addFilter
```
void addFilter(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:
    
    filter - the filter to add (required)
  - addPluginRepositories
```
void addPluginRepositories(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:
    
    repositories - a list of plugin repositories to add (required)
  - addPluginRepository
```
void addPluginRepository(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:
    
    repository - the plugin repository to add (required)
  - addProperty
```
void addProperty(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:
    
    property - the property to add (required)
  - addRepositories
```
void addRepositories(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:
    
    repositories - a list of repositories to add (required)
  - addRepository
```
void addRepository(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:
    
    repository - the repository to add (required)
  - addResource
```
void addResource(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:
    
    resource - the resource to add (required)
  - removeBuildPlugin
```
void removeBuildPlugin(Plugin plugin)
```
    Removes any plugins with the same groupId and artifactId as the given plugin.
    
    Parameters:
    
    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(Collection<? extends Plugin> plugins)
```
    Removes any plugins with the same groupId and artifactId as any of the given plugins.
    
    Parameters:
    
    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(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:
    
    dependencies - the dependencies to remove (required)
  - removeDependency
```
void removeDependency(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:
    
    dependency - the dependency to remove (required)
  - removeFilter
```
void removeFilter(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:
    
    filter - the filter to remove (required)
  - removePluginRepository
```
void removePluginRepository(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:
    
    repository - the plugin repository to remove (required)
  - removeProperty
```
void removeProperty(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:
    
    property - the property to remove (required)
  - removeRepository
```
void removeRepository(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:
    
    repository - the repository to remove (required)
  - removeResource
```
void removeResource(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:
    
    resource - the resource to remove (required)
  - updateDependencyScope
```
void updateDependencyScope(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:
    
    dependency - the dependency to update (required)
    
    dependencyScope - the dependency scope. May be null, in which case the element will be removed
  - updateProjectType
```
void updateProjectType(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:
    
    projectType - the project type to update (required)

Interface ProjectMetadataProvider

Method Summary

Methods inherited from interface org.springframework.roo.metadata.MetadataProvider

Method Detail

addBuildPlugin

addBuildPlugins

addDependencies

addDependency

addFilter

addPluginRepositories

addPluginRepository

addProperty

addRepositories

addRepository

addResource

removeBuildPlugin

removeBuildPlugins

removeDependencies

removeDependency

removeFilter

removePluginRepository

removeProperty

removeRepository

removeResource

updateDependencyScope

updateProjectType