Pom (Spring Roo - Runtime - Project 2.0.0.RC2 API)

java.lang.Object
- org.springframework.roo.project.maven.Pom

```
public class Pom
extends Object
```
A Maven project object model (POM).

Since:

1.2.0

Author:

James Tyrrell, Andrew Swan, Juan Carlos García

Field Summary

Fields
Modifier and Type Field and Description

static String ROOT_MODULE_SYMBOL

Fields
Modifier and Type	Field and Description
`static String`	`ROOT_MODULE_SYMBOL`

Constructor Summary

Constructors
Constructor and Description
Pom(String groupId, String artifactId, String version, String packaging, Collection<? extends Dependency> dependenciesInDependencyManagement, Collection<? extends Dependency> dependencies, Parent parent, Collection<? extends Module> modules, Collection<? extends Property> pomProperties, String name, Collection<? extends Repository> repositories, Collection<? extends Repository> pluginRepositories, String sourceDirectory, String testSourceDirectory, Collection<? extends Filter> filters, Collection<? extends Plugin> pluginsInPluginManagement, Collection<? extends Plugin> buildPlugins, Collection<? extends Resource> resources, String path, String moduleName, Collection<Path> paths) Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Dependency`	`asDependency(DependencyScope scope)` Returns this module as a Dependency with the given scope
`Dependency`	`asDependency(DependencyScope scope, DependencyType type)` Returns this module as a Dependency with the given scope and type
`boolean`	`canAddDependency(Dependency newDependency, boolean checkVersion)` Indicates whether it's valid to add the given `Dependency` to this POM.
`boolean`	`canAddDependencyToDependencyManagement(Dependency newDependency, boolean checkVersion)` Indicates whether it's valid to add the given `Dependency` to the dependencyManagement of this pom
`boolean`	`canAddPluginToPluginManagement(Plugin newPlugin, boolean checkVersion)` Indicates whether it's valid to add the given `Plugin` to the pluginManagement of this pom
`String`	`getArtifactId()` Returns the ID of the artifact created by this module or project
`Set<Plugin>`	`getBuildPlugins()` Returns any registered build plugins
`Set<Plugin>`	`getBuildPluginsExcludingVersion(Plugin plugin)` Returns any build plugins with the same groupId and artifactId as the given plugin.
`Set<Dependency>`	`getDependencies()`
`Set<Dependency>`	`getDependenciesExcludingVersion(Dependency dependency)` Locates any dependencies which match the presented dependency, excluding the version number.
`String`	`getDisplayName()` Returns the display name of this module of the user project
`Set<Filter>`	`getFilters()`
`String`	`getGroupId()` Returns the ID of the organisation or group that owns this module or project
`String`	`getModuleName()` Returns the programmatic name of this module of the user project
`Set<Module>`	`getModules()`
`String`	`getName()` Deprecated. use `getDisplayName()` instead
`String`	`getPackaging()`
`Parent`	`getParent()`
`String`	`getPath()` Returns this descriptor's canonical path on the file system
`String`	`getPathLocation(Path path)` Returns the canonical path of the given `Path` within this module, plus a trailing separator if found
`PhysicalPath`	`getPhysicalPath(Path path)` Returns the `PhysicalPath` for the given `Path` of this module
`List<PhysicalPath>`	`getPhysicalPaths()`
`Set<Repository>`	`getPluginRepositories()`
`Set<Property>`	`getPomProperties()`
`Set<Property>`	`getPropertiesExcludingValue(Property property)` Locates any properties which match the presented property, excluding the value.
`Property`	`getProperty(String name)` Locates the first occurrence of a property for a given name and returns it.
`Set<Repository>`	`getRepositories()`
`Set<Resource>`	`getResources()`
`String`	`getRoot()` Returns the canonical path of this module's root directory, plus a trailing separator
`String`	`getSourceDirectory()`
`String`	`getTestSourceDirectory()`
`String`	`getVersion()` Returns the version number of this module or project
`boolean`	`hasDependencyExcludingVersion(Dependency dependency)` Indicates whether this `Pom` has the given `Dependency`, ignoring the version number.
`boolean`	`isAllDependenciesRegistered(Collection<? extends Dependency> dependencies)` Indicates whether all of the given dependencies are registered, by calling `#isDependencyRegistered(Dependency)` for each one, ignoring any `null` elements.
`boolean`	`isAllPluginRepositoriesRegistered(Collection<? extends Repository> repositories)` Indicates whether all the given plugin repositories are registered, by calling `isPluginRepositoryRegistered(Repository)` for each one, ignoring any `null` elements.
`boolean`	`isAllPluginsRegistered(Collection<? extends Plugin> plugins)` Indicates whether all of the given plugins are registered, based on their groupId, artifactId, and version.
`boolean`	`isAllRepositoriesRegistered(Collection<? extends Repository> repositories)` Indicates whether all the given repositories are registered.
`boolean`	`isAnyDependenciesRegistered(Collection<? extends Dependency> dependencies)` Indicates whether any of the given dependencies are registered, by calling `#isDependencyRegistered(Dependency)` for each one.
`boolean`	`isAnyPluginsRegistered(Collection<? extends Plugin> plugins)` Indicates whether any of the given plugins are registered, by calling `isBuildPluginRegistered(Plugin)` for each one.
`boolean`	`isBuildPluginRegistered(Plugin plugin)` Deprecated. use `isPluginRegistered(GAV)` instead
`boolean`	`isDependencyRegistered(Dependency dependency, boolean checkVersion)` Indicates whether the given dependency is registered without checking dependency version , by checking the result of `Dependency.equals(Object)`.
`boolean`	`isDependencyRegisteredInDependencyManagement(Dependency dependency, boolean checkVersion)` Indicates whether the given dependency is registered in dependencyManagement without checking dependency version , by checking the result of `Dependency.equals(Object)`.
`boolean`	`isFilterRegistered(Filter filter)` Indicates whether the given filter is registered.
`boolean`	`isPluginRegistered(GAV gav)` Indicates whether a plugin with the given coordinates is registered
`boolean`	`isPluginRegisteredInPluginManagement(Plugin plugin, boolean checkVersion)` Indicates whether the given plugin is registered in pluginManagement without checking plugin version , by checking the result of `Plugin.equals(Object)`.
`boolean`	`isPluginRepositoryRegistered(Repository repository)` Indicates whether the given plugin repository is registered.
`boolean`	`isPropertyRegistered(Property property)` Indicates whether the given build property is registered.
`boolean`	`isRepositoryRegistered(Repository repository)` Indicates whether the given repository is registered.
`boolean`	`isResourceRegistered(Resource resource)` Indicates whether the given resource is registered.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ROOT_MODULE_SYMBOL
```
public static final String ROOT_MODULE_SYMBOL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Pom
```
public Pom(String groupId,
           String artifactId,
           String version,
           String packaging,
           Collection<? extends Dependency> dependenciesInDependencyManagement,
           Collection<? extends Dependency> dependencies,
           Parent parent,
           Collection<? extends Module> modules,
           Collection<? extends Property> pomProperties,
           String name,
           Collection<? extends Repository> repositories,
           Collection<? extends Repository> pluginRepositories,
           String sourceDirectory,
           String testSourceDirectory,
           Collection<? extends Filter> filters,
           Collection<? extends Plugin> pluginsInPluginManagement,
           Collection<? extends Plugin> buildPlugins,
           Collection<? extends Resource> resources,
           String path,
           String moduleName,
           Collection<Path> paths)
```
    Constructor
    
    Parameters:
    
    groupId - the Maven groupId, explicit or inherited (required)
    
    artifactId - the Maven artifactId (required)
    
    version - the version of the artifact being built (required)
    
    packaging - the Maven packaging (required)
    
    dependenciesInDependencyManagement - (can be null for none)
    
    dependencies - (can be null for none)
    
    parent - the POM's parent declaration (can be null for none)
    
    modules - the modules defined by this POM (only applies when packaging is "pom"; can be null for none)
    
    pomProperties - any properties defined in the POM (can be null for none)
    
    name - the Maven name of the artifact being built (can be blank)
    
    repositories - any repositories defined in the POM (can be null for none)
    
    pluginRepositories - any plugin repositories defined in the POM (can be null for none)
    
    sourceDirectory - the directory relative to the POM that contains production code (can be blank for the Maven default)
    
    testSourceDirectory - the directory relative to the POM that contains test code (can be blank for the Maven default)
    
    filters - any filters defined in the POM (can be null for none)
    
    pluginsInPluginManagement - any plugin defined in pluginManagement section
    
    buildPlugins - any plugins defined in the POM (can be null for none)
    
    resources - any build resources defined in the POM (can be null for none)
    
    path - the canonical path of this POM (required)
    
    moduleName - the Maven name of this module (blank for the project's root or only POM)
    
    paths - the Paths required for this module, in addition to the root (can be null)
- Method Detail
  - asDependency
```
public Dependency asDependency(DependencyScope scope)
```
    Returns this module as a Dependency with the given scope
    
    Parameters:
    
    scope - the DependencyScope to use
    
    Returns:
    
    a non-null instance
  - asDependency
```
public Dependency asDependency(DependencyScope scope,
                               DependencyType type)
```
    Returns this module as a Dependency with the given scope and type
    
    Parameters:
    
    scope - the DependencyScope to use
    
    type - the DependencyType to use
    
    Returns:
    
    a non-null instance
  - canAddDependency
```
public boolean canAddDependency(Dependency newDependency,
                                boolean checkVersion)
```
    Indicates whether it's valid to add the given Dependency to this POM.
    
    Parameters:
    
    newDependency - the Dependency to check (can be null)
    
    Returns:
    
    see above
    
    Since:
    
    1.2.1
  - canAddDependencyToDependencyManagement
```
public boolean canAddDependencyToDependencyManagement(Dependency newDependency,
                                                      boolean checkVersion)
```
    Indicates whether it's valid to add the given Dependency to the dependencyManagement of this pom
    
    Parameters:
    
    newDependency - the Dependency to check (can be null)
    
    Returns:
    
    see above
    
    Since:
    
    2.0
  - canAddPluginToPluginManagement
```
public boolean canAddPluginToPluginManagement(Plugin newPlugin,
                                              boolean checkVersion)
```
    Indicates whether it's valid to add the given Plugin to the pluginManagement of this pom
    
    Parameters:
    
    newPlugin - the Plugin to check (can be null)
    
    Returns:
    
    see above
    
    Since:
    
    2.0
  - getArtifactId
```
public String getArtifactId()
```
    Returns the ID of the artifact created by this module or project
    
    Returns:
    
    a non-blank ID
  - getBuildPlugins
```
public Set<Plugin> getBuildPlugins()
```
    Returns any registered build plugins
    
    Returns:
    
    a non-null collection
  - getBuildPluginsExcludingVersion
```
public Set<Plugin> getBuildPluginsExcludingVersion(Plugin plugin)
```
    Returns any build plugins with the same groupId and artifactId as the given plugin. This is useful for upgrade cases.
    
    Parameters:
    
    plugin - to locate (required; note the version number is ignored in comparisons)
    
    Returns:
    
    any matching plugins (never returns null, but may return an empty Set)
  - getDependencies
```
public Set<Dependency> getDependencies()
```
  - getDependenciesExcludingVersion
```
public Set<Dependency> getDependenciesExcludingVersion(Dependency dependency)
```
    Locates any dependencies which match the presented dependency, excluding the version number. This is useful for upgrade use cases, where it is necessary to remove any dependencies with the same group id, artifact id, and type as the dependency being upgraded to.
    
    Parameters:
    
    dependency - to locate (can be null)
    
    Returns:
    
    any matching dependencies (never returns null, but may return an empty Set)
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name of this module of the user project
    
    Returns:
    
    a non-blank name
  - getFilters
```
public Set<Filter> getFilters()
```
  - getGroupId
```
public String getGroupId()
```
    Returns the ID of the organisation or group that owns this module or project
    
    Returns:
    
    a non-blank ID
  - getModuleName
```
public String getModuleName()
```
    Returns the programmatic name of this module of the user project
    
    Returns:
    
    an empty string for the root or only module
  - getModules
```
public Set<Module> getModules()
```
  - getName
```
@Deprecated
public String getName()
```
    Deprecated. use getDisplayName() instead
    
    Returns the display name of this module of the user project
    
    Returns:
    
    a non-blank name
  - getPackaging
```
public String getPackaging()
```
  - getParent
```
public Parent getParent()
```
  - getPath
```
public String getPath()
```
    Returns this descriptor's canonical path on the file system
    
    Returns:
    
    a valid canonical path
  - getPathLocation
```
public String getPathLocation(Path path)
```
    Returns the canonical path of the given Path within this module, plus a trailing separator if found
    
    Parameters:
    
    path - the path for which to get the canonical location (required)
    
    Returns:
    
    null if this module has no such path
  - getPhysicalPath
```
public PhysicalPath getPhysicalPath(Path path)
```
    Returns the PhysicalPath for the given Path of this module
    
    Parameters:
    
    path - the sub-path for which to return the PhysicalPath
    
    Returns:
    
    null if this module has no such sub-path
  - getPhysicalPaths
```
public List<PhysicalPath> getPhysicalPaths()
```
  - getPluginRepositories
```
public Set<Repository> getPluginRepositories()
```
  - getPomProperties
```
public Set<Property> getPomProperties()
```
  - getPropertiesExcludingValue
```
public Set<Property> getPropertiesExcludingValue(Property property)
```
    Locates any properties which match the presented property, excluding the value. This is useful for upgrade use cases, where it is necessary to locate any properties with the name so that they can be removed.
    
    Parameters:
    
    property - to locate (required; note the value is ignored in comparisons)
    
    Returns:
    
    any matching properties (never returns null, but may return an empty Set)
  - getProperty
```
public Property getProperty(String name)
```
    Locates the first occurrence of a property for a given name and returns it.
    
    Parameters:
    
    name - the property name (required)
    
    Returns:
    
    the property if found otherwise null
  - getRepositories
```
public Set<Repository> getRepositories()
```
  - getResources
```
public Set<Resource> getResources()
```
  - getRoot
```
public String getRoot()
```
    Returns the canonical path of this module's root directory, plus a trailing separator
    
    Returns:
    
    a valid canonical path
  - getSourceDirectory
```
public String getSourceDirectory()
```
  - getTestSourceDirectory
```
public String getTestSourceDirectory()
```
  - getVersion
```
public String getVersion()
```
    Returns the version number of this module or project
    
    Returns:
    
    a non-blank version number
  - hasDependencyExcludingVersion
```
public boolean hasDependencyExcludingVersion(Dependency dependency)
```
    Indicates whether this Pom has the given Dependency, ignoring the version number.
    
    Parameters:
    
    dependency - the Dependency to check for (can be null)
    
    Returns:
    
    false if a null dependency is given
    
    Since:
    
    1.2.1
  - isAllDependenciesRegistered
```
public boolean isAllDependenciesRegistered(Collection<? extends Dependency> dependencies)
```
    Indicates whether all of the given dependencies are registered, by calling #isDependencyRegistered(Dependency) for each one, ignoring any null elements.
    
    Parameters:
    
    dependencies - the dependencies to check (can be null or contain null elements)
    
    Returns:
    
    true if a null or empty collection is given
  - isAllPluginRepositoriesRegistered
```
public boolean isAllPluginRepositoriesRegistered(Collection<? extends Repository> repositories)
```
    Indicates whether all the given plugin repositories are registered, by calling isPluginRepositoryRegistered(Repository) for each one, ignoring any null elements.
    
    Parameters:
    
    repositories - the plugin repositories to check (can be null)
    
    Returns:
    
    true if a null collection is given
  - isAllPluginsRegistered
```
public boolean isAllPluginsRegistered(Collection<? extends Plugin> plugins)
```
    Indicates whether all of the given plugins are registered, based on their groupId, artifactId, and version.
    
    Parameters:
    
    plugins - the plugins to check (required)
    
    Returns:
    
    false if any of them are not registered
  - isAllRepositoriesRegistered
```
public boolean isAllRepositoriesRegistered(Collection<? extends Repository> repositories)
```
    Indicates whether all the given repositories are registered. Equivalent to calling isRepositoryRegistered(Repository) for each one, ignoring any null elements.
    
    Parameters:
    
    repositories - the repositories to check (can be null)
    
    Returns:
    
    true if a null collection is given
  - isAnyDependenciesRegistered
```
public boolean isAnyDependenciesRegistered(Collection<? extends Dependency> dependencies)
```
    Indicates whether any of the given dependencies are registered, by calling #isDependencyRegistered(Dependency) for each one.
    
    Parameters:
    
    dependencies - the dependencies to check (can be null)
    
    Returns:
    
    see above
  - isAnyPluginsRegistered
```
public boolean isAnyPluginsRegistered(Collection<? extends Plugin> plugins)
```
    Indicates whether any of the given plugins are registered, by calling isBuildPluginRegistered(Plugin) for each one.
    
    Parameters:
    
    plugins - the plugins to check (required)
    
    Returns:
    
    whether any of the plugins are currently registered or not
  - isBuildPluginRegistered
```
@Deprecated
public boolean isBuildPluginRegistered(Plugin plugin)
```
    Deprecated. use isPluginRegistered(GAV) instead
    
    Indicates whether the given build plugin is registered, based on its groupId, artifactId, and version.
    
    Parameters:
    
    plugin - to check (required)
    
    Returns:
    
    whether the build plugin is currently registered or not
  - isDependencyRegistered
```
public boolean isDependencyRegistered(Dependency dependency,
                                      boolean checkVersion)
```
    Indicates whether the given dependency is registered without checking dependency version , by checking the result of Dependency.equals(Object).
    
    Parameters:
    
    dependency - the dependency to check (can be null)
    
    Returns:
    
    false if a null dependency is given
  - isDependencyRegisteredInDependencyManagement
```
public boolean isDependencyRegisteredInDependencyManagement(Dependency dependency,
                                                            boolean checkVersion)
```
    Indicates whether the given dependency is registered in dependencyManagement without checking dependency version , by checking the result of Dependency.equals(Object).
    
    Parameters:
    
    dependency - the dependency to check (can be null)
    
    Returns:
    
    false if a null dependency is given
  - isPluginRegisteredInPluginManagement
```
public boolean isPluginRegisteredInPluginManagement(Plugin plugin,
                                                    boolean checkVersion)
```
    Indicates whether the given plugin is registered in pluginManagement without checking plugin version , by checking the result of Plugin.equals(Object).
    
    Parameters:
    
    plugin - the plugin to check (can be null)
    
    Returns:
    
    false if a null dependency is given
  - isFilterRegistered
```
public boolean isFilterRegistered(Filter filter)
```
    Indicates whether the given filter is registered.
    
    Parameters:
    
    filter - to check (required)
    
    Returns:
    
    whether the filter is currently registered or not
  - isPluginRegistered
```
public boolean isPluginRegistered(GAV gav)
```
    Indicates whether a plugin with the given coordinates is registered
    
    Parameters:
    
    coordinates - the coordinates to match upon; can be null
    
    Returns:
    
    false if null coordinates are given
  - isPluginRepositoryRegistered
```
public boolean isPluginRepositoryRegistered(Repository repository)
```
    Indicates whether the given plugin repository is registered.
    
    Parameters:
    
    repository - repository to check (can be null)
    
    Returns:
    
    false if a null repository is given
  - isPropertyRegistered
```
public boolean isPropertyRegistered(Property property)
```
    Indicates whether the given build property is registered.
    
    Parameters:
    
    property - to check (required)
    
    Returns:
    
    whether the property is currently registered or not
  - isRepositoryRegistered
```
public boolean isRepositoryRegistered(Repository repository)
```
    Indicates whether the given repository is registered.
    
    Parameters:
    
    repository - to check (can be null)
    
    Returns:
    
    false if a null repository is given
  - isResourceRegistered
```
public boolean isResourceRegistered(Resource resource)
```
    Indicates whether the given resource is registered.
    
    Parameters:
    
    resource - to check (required)
    
    Returns:
    
    whether the resource is currently registered or not
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Pom

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_MODULE_SYMBOL

Constructor Detail

Pom

Method Detail

asDependency

asDependency

canAddDependency

canAddDependencyToDependencyManagement

canAddPluginToPluginManagement

getArtifactId

getBuildPlugins

getBuildPluginsExcludingVersion

getDependencies

getDependenciesExcludingVersion

getDisplayName

getFilters

getGroupId

getModuleName

getModules

getName

getPackaging

getParent

getPath

getPathLocation

getPhysicalPath

getPhysicalPaths

getPluginRepositories

getPomProperties

getPropertiesExcludingValue

getProperty

getRepositories

getResources

getRoot

getSourceDirectory

getTestSourceDirectory

getVersion

hasDependencyExcludingVersion

isAllDependenciesRegistered

isAllPluginRepositoriesRegistered

isAllPluginsRegistered

isAllRepositoriesRegistered

isAnyDependenciesRegistered

isAnyPluginsRegistered

isBuildPluginRegistered

isDependencyRegistered

isDependencyRegisteredInDependencyManagement

isPluginRegisteredInPluginManagement

isFilterRegistered

isPluginRegistered

isPluginRepositoryRegistered

isPropertyRegistered

isRepositoryRegistered

isResourceRegistered

toString