fr.fastconnect.factory.tibco.bw.maven.source

Class POMManager

java.lang.Object

fr.fastconnect.factory.tibco.bw.maven.source.POMManager

public class POMManager
extends java.lang.Object

This class handles POM file manipulation using the Maven API.

Constructor Summary

Constructors

Constructor and Description
POMManager()

Method Summary

Modifier and Type	Method and Description
static void	addDependency(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Add the Maven dependency to a POM file.
static void	addDependencyManagement(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Add the Maven dependency to a POM file (in management section).
static void	addProjectAsModule(java.io.File pom, java.lang.String relativePath, java.lang.String profileId, org.apache.maven.plugin.logging.Log logger) Add a project as a module.
static boolean	dependencyExists(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Check whether a dependency exists in a POM.
static boolean	dependencyExistsManagement(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Check whether a dependency exists in a POM (in management section).
static org.apache.maven.model.Model	getModelFromPOM(java.io.File pom, org.apache.maven.plugin.logging.Log logger) Load a Maven Model object from a POM file.
static org.apache.maven.model.Profile	getProfile(org.apache.maven.model.Model model, java.lang.String profileId)
static org.apache.maven.model.Model	mergeModelFromPOM(java.io.File pom, org.apache.maven.model.Model existingModel, org.apache.maven.plugin.logging.Log logger) Merge a Maven Model object from a POM file to an existing Maven Model object.
static boolean	moduleExists(java.io.File pom, java.lang.String relativePath, java.lang.String profileId, org.apache.maven.plugin.logging.Log logger) Check whether a module exists in a POM.
static void	removeDependency(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Remove the Maven dependency from a POM file.
static void	removeDependencyManagement(java.io.File pom, org.apache.maven.model.Dependency dependency, org.apache.maven.plugin.logging.Log logger) Remove the Maven dependency from a POM file (in management section).
static void	removeProjectAsModule(java.io.File pom, java.lang.String relativePath, java.lang.String profileId, org.apache.maven.plugin.logging.Log logger)
static void	writeModelToPOM(org.apache.maven.model.Model model, java.io.File pom, org.apache.maven.plugin.logging.Log logger) Write a Maven Model object to a POM file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

POMManager

public POMManager()

Method Detail

getModelFromPOM

public static org.apache.maven.model.Model getModelFromPOM(java.io.File pom,
                                                           org.apache.maven.plugin.logging.Log logger)
                                                    throws java.io.IOException,
                                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Load a Maven Model object from a POM file.

Parameters:

pom -

logger -

Returns:

the model parsed from the POM file

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

java.io.IOException

mergeModelFromPOM

public static org.apache.maven.model.Model mergeModelFromPOM(java.io.File pom,
                                                             org.apache.maven.model.Model existingModel,
                                                             org.apache.maven.plugin.logging.Log logger)
                                                      throws java.io.IOException,
                                                             org.codehaus.plexus.util.xml.pull.XmlPullParserException

Merge a Maven Model object from a POM file to an existing Maven Model object.

Parameters:

pom -

existingModel -

logger -

Returns:

the existing model merged with the parsed model from the POM file

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

java.io.IOException

writeModelToPOM

public static void writeModelToPOM(org.apache.maven.model.Model model,
                                   java.io.File pom,
                                   org.apache.maven.plugin.logging.Log logger)
                            throws java.io.IOException

Write a Maven Model object to a POM file.

Parameters:

model -

pom -

logger -

Throws:

java.io.IOException

addDependency

public static void addDependency(java.io.File pom,
                                 org.apache.maven.model.Dependency dependency,
                                 org.apache.maven.plugin.logging.Log logger)
                          throws java.io.IOException,
                                 org.codehaus.plexus.util.xml.pull.XmlPullParserException

Add the Maven dependency to a POM file.

Parameters:

pom -

dependency -

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

addDependencyManagement

public static void addDependencyManagement(java.io.File pom,
                                           org.apache.maven.model.Dependency dependency,
                                           org.apache.maven.plugin.logging.Log logger)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Add the Maven dependency to a POM file (in management section).

Parameters:

pom -

dependency -

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

removeDependency

public static void removeDependency(java.io.File pom,
                                    org.apache.maven.model.Dependency dependency,
                                    org.apache.maven.plugin.logging.Log logger)
                             throws java.io.IOException,
                                    org.codehaus.plexus.util.xml.pull.XmlPullParserException

Remove the Maven dependency from a POM file.

Parameters:

pom -

dependency -

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

removeDependencyManagement

public static void removeDependencyManagement(java.io.File pom,
                                              org.apache.maven.model.Dependency dependency,
                                              org.apache.maven.plugin.logging.Log logger)
                                       throws java.io.IOException,
                                              org.codehaus.plexus.util.xml.pull.XmlPullParserException

Remove the Maven dependency from a POM file (in management section).

Parameters:

pom -

dependency -

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

dependencyExists

public static boolean dependencyExists(java.io.File pom,
                                       org.apache.maven.model.Dependency dependency,
                                       org.apache.maven.plugin.logging.Log logger)
                                throws java.io.IOException,
                                       org.codehaus.plexus.util.xml.pull.XmlPullParserException

Check whether a dependency exists in a POM.

Parameters:

pom -

dependency -

logger -

Returns:

true if the dependency exists in the POM

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

dependencyExistsManagement

public static boolean dependencyExistsManagement(java.io.File pom,
                                                 org.apache.maven.model.Dependency dependency,
                                                 org.apache.maven.plugin.logging.Log logger)
                                          throws java.io.IOException,
                                                 org.codehaus.plexus.util.xml.pull.XmlPullParserException

Check whether a dependency exists in a POM (in management section).

Parameters:

pom -

dependency -

logger -

Returns:

true if the dependency exists in the management section of the POM

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getProfile

public static org.apache.maven.model.Profile getProfile(org.apache.maven.model.Model model,
                                                        java.lang.String profileId)

addProjectAsModule

public static void addProjectAsModule(java.io.File pom,
                                      java.lang.String relativePath,
                                      java.lang.String profileId,
                                      org.apache.maven.plugin.logging.Log logger)
                               throws java.io.IOException,
                                      org.codehaus.plexus.util.xml.pull.XmlPullParserException

Add a project as a module.

Parameters:

pom -

relativePath -

logger -

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

removeProjectAsModule

public static void removeProjectAsModule(java.io.File pom,
                                         java.lang.String relativePath,
                                         java.lang.String profileId,
                                         org.apache.maven.plugin.logging.Log logger)
                                  throws java.io.IOException,
                                         org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

moduleExists

public static boolean moduleExists(java.io.File pom,
                                   java.lang.String relativePath,
                                   java.lang.String profileId,
                                   org.apache.maven.plugin.logging.Log logger)
                            throws java.io.IOException,
                                   org.codehaus.plexus.util.xml.pull.XmlPullParserException

Check whether a module exists in a POM.

Parameters:

rootPOM -

relative -

log -

Returns:

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

java.io.IOException