com.mulesoft.tools.migration.project.model.pom

Class PomModel

java.lang.Object

com.mulesoft.tools.migration.project.model.pom.PomModel

public class PomModel
extends Object

The pom model.

Since:

1.0.0

Author:

Mulesoft Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PomModel.PomModelBuilder The pom model builder.

Constructor Summary

Constructors

Constructor and Description
PomModel()

Method Summary

Modifier and Type	Method and Description
boolean	addDependency(Dependency dependency) Adds a dependency to the pom model dependencies list.
void	addPlugin(Plugin plugin) Adds a plugin to the build section in the pom.
void	addPluginRepository(Repository repository) Adds a Repository to the PomModel in the plugin repository section.
void	addProperty(String key, String value) Sets a key-valued pair in the properties map.
void	addRepository(Repository repository) Adds a Repository to the PomModel in the repository section.
String	getArtifactId() Retrieves the artifact id declared in the pom.
List<Dependency>	getDependencies() Retrieves the list of dependencies in the pom model.
String	getGroupId() Retrieves the group id declared in the pom.
org.apache.maven.model.Model	getMavenModelCopy() Retrieves a deep copy of the maven model.
String	getModelVersion() Retrieves the pom model version.
String	getName() Retrieves the name declared in the pom.
String	getPackaging() Retrieves the packaging type declared in the pom.
List<Plugin>	getPlugins() Retrieves the list of plugins declared in the build section.
List<org.apache.maven.model.Profile>	getProfiles()
Properties	getProperties() Retrieves the properties declared in the pom.
String	getVersion() Retrieves the version declared in the pom.
boolean	removeDependency(Dependency dependency) Removes a dependency from the pom model dependencies list.
void	removePlugin(Plugin plugin) Removes the specified plugin from the list of plugins declared in the build section.
Optional<Plugin>	removePlugin(Predicate<Plugin> pluginPredicate) Remove the first plugins that satisfies a predicate.
List<Plugin>	removePlugins(Predicate<Plugin> pluginPredicate) Remove all the plugins that satisfies a predicate.
void	removeProperty(String propertyName) Removes a property from the pom model properties.
void	setArtifactId(String artifactId) Sets the artifact id in the pom.
void	setDependencies(List<Dependency> dependencies) Sets the dependencies in the pom model.
void	setGroupId(String groupId) Sets the group id in the pom.
void	setModelVersion(String modelVersion) Sets the pom model version.
void	setName(String name) Sets the name in the pom.
void	setPackaging(String packaging) Sets the packaging type in the pom.
void	setProperties(Properties properties) Sets the properties in the pom.
void	setVersion(String version) Sets the version in the pom.

Methods inherited from class java.lang.Object

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

Constructor Detail

PomModel

public PomModel()

Method Detail

getDependencies

public List<Dependency> getDependencies()

Retrieves the list of dependencies in the pom model.

Returns:

a List

setDependencies

public void setDependencies(List<Dependency> dependencies)

Sets the dependencies in the pom model.

Parameters:

dependencies - the list of the dependencies to be set in the pom model

addDependency

public boolean addDependency(Dependency dependency)

Adds a dependency to the pom model dependencies list. The dependency is not added if another dependency with same artifact id, group id and version is already present in the dependencies list

Parameters:

dependency - the dependencies to be added to the pom model

Returns:

true if the dependency was added to the dependency list; false otherwise

removeDependency

public boolean removeDependency(Dependency dependency)

Removes a dependency from the pom model dependencies list.

Parameters:

dependency - the dependency to be removed from the dependencies list

Returns:

true if the dependency was removed from the dependency list; false otherwise

getPackaging

public String getPackaging()

Retrieves the packaging type declared in the pom.

Returns:

a String

getMavenModelCopy

public org.apache.maven.model.Model getMavenModelCopy()

Retrieves a deep copy of the maven model.

Returns:

a Model

setPackaging

public void setPackaging(String packaging)

Sets the packaging type in the pom.

Parameters:

packaging -

getArtifactId

public String getArtifactId()

Retrieves the artifact id declared in the pom.

Returns:

a String

setArtifactId

public void setArtifactId(String artifactId)

Sets the artifact id in the pom.

Parameters:

artifactId -

getGroupId

public String getGroupId()

Retrieves the group id declared in the pom.

Returns:

a String

setGroupId

public void setGroupId(String groupId)

Sets the group id in the pom.

Parameters:

groupId -

getVersion

public String getVersion()

Retrieves the version declared in the pom.

Returns:

a String

setVersion

public void setVersion(String version)

Sets the version in the pom.

Parameters:

version -

getName

public String getName()

Retrieves the name declared in the pom.

Returns:

a String

setName

public void setName(String name)

Sets the name in the pom.

Parameters:

name -

getProperties

public Properties getProperties()

Retrieves the properties declared in the pom.

Returns:

a Properties

setProperties

public void setProperties(Properties properties)

Sets the properties in the pom.

Parameters:

properties -

addProperty

public void addProperty(String key,
                        String value)

Sets a key-valued pair in the properties map.

Parameters:

key -

value -

removeProperty

public void removeProperty(String propertyName)

Removes a property from the pom model properties.

Parameters:

propertyName -

Throws:

NullPointerException - if the key is null

setModelVersion

public void setModelVersion(String modelVersion)

Sets the pom model version.

Parameters:

modelVersion -

getModelVersion

public String getModelVersion()

Retrieves the pom model version.

Returns:

a String

addPlugin

public void addPlugin(Plugin plugin)

Adds a plugin to the build section in the pom.

Parameters:

plugin -

getPlugins

public List<Plugin> getPlugins()

Retrieves the list of plugins declared in the build section.

Returns:

a List

removePlugin

public void removePlugin(Plugin plugin)

Removes the specified plugin from the list of plugins declared in the build section.

Parameters:

plugin -

removePlugins

public List<Plugin> removePlugins(Predicate<Plugin> pluginPredicate)

Remove all the plugins that satisfies a predicate.

Parameters:

pluginPredicate - a predicate that evaluates to true if the plugin should be removed

Returns:

the list of plugins removed

removePlugin

public Optional<Plugin> removePlugin(Predicate<Plugin> pluginPredicate)

Remove the first plugins that satisfies a predicate.

Parameters:

pluginPredicate - a predicate that evaluates to true if the plugin should be removed

Returns:

an optional of the removed plugin

getProfiles

public List<org.apache.maven.model.Profile> getProfiles()

addRepository

public void addRepository(Repository repository)

Adds a Repository to the PomModel in the repository section.

Parameters:

repository -

addPluginRepository

public void addPluginRepository(Repository repository)

Adds a Repository to the PomModel in the plugin repository section.

Parameters:

repository -