Package org.codehaus.mojo.versions

Class UpdateParentMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.UpdateParentMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="update-parent",
      threadSafe=true)
public class UpdateParentMojo
extends AbstractVersionsUpdaterMojo

Sets the parent version to the latest parent version.

Since:

1.0-alpha-1

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowDowngrade	Whether to downgrade a snapshot dependency if allowSnapshots is false and there exists a version within the range fulfilling the criteria.
protected boolean	allowIncrementalUpdates	Whether to allow the incremental version number to be changed.
protected boolean	allowMajorUpdates	Whether to allow the major version number to be changed.
protected boolean	allowMinorUpdates	Whether to allow the minor version number to be changed.
protected boolean	forceUpdate	to update parent version by force when it is RELEASE or LATEST
protected String	parentVersion	If skipResolution is not set, specifies the bottom version considered for target version resolution.
protected boolean	skipResolution	Skips version resolution, only valid if parentVersion is set.

Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

allowSnapshots, artifactHandlerManager, generateBackupPoms, ignoredVersions, project, reactorProjects, repositorySystem, ruleSet, session, wagonMap

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateParentMojo(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, Map<String,ChangeRecorder> changeRecorders)

Method Summary

Modifier and Type	Method	Description
protected org.apache.maven.artifact.versioning.ArtifactVersion	resolveTargetVersion()
protected void	update(MutableXMLStreamReader pom)	Updates the pom.

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getVersion, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, updatePropertyToNewestVersion, validateInput

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

parentVersion

@Parameter(property="parentVersion")
protected String parentVersion

If skipResolution is not set, specifies the bottom version considered for target version resolution. If it is a version range, the resolved version will be restricted by that range.

If skipResolution is true, will specify the target version to which the parent artifact will be updated.

Since:

1.0-alpha-1

forceUpdate

@Parameter(property="forceUpdate",
           defaultValue="false")
protected boolean forceUpdate

to update parent version by force when it is RELEASE or LATEST

Since:

2.9

skipResolution

@Parameter(property="skipResolution",
           defaultValue="false")
protected boolean skipResolution

Skips version resolution, only valid if parentVersion is set. Will effectively set the new parent version to the one from parentVersion

Since:

2.13.0

allowDowngrade

@Parameter(property="allowDowngrade",
           defaultValue="false")
protected boolean allowDowngrade

Whether to downgrade a snapshot dependency if allowSnapshots is false and there exists a version within the range fulfilling the criteria.

Default false

Since:

2.12.0

allowMajorUpdates

@Parameter(property="allowMajorUpdates",
           defaultValue="true")
protected boolean allowMajorUpdates

Whether to allow the major version number to be changed.

Since:

2.13.0

allowMinorUpdates

@Parameter(property="allowMinorUpdates",
           defaultValue="true")
protected boolean allowMinorUpdates

Whether to allow the minor version number to be changed.

Note: false also implies allowMajorUpdates false

Since:

2.13.0

allowIncrementalUpdates

@Parameter(property="allowIncrementalUpdates",
           defaultValue="true")
protected boolean allowIncrementalUpdates

Whether to allow the incremental version number to be changed.

Note: false also implies allowMajorUpdates and allowMinorUpdates false

Since:

2.13.0

Constructor Details

UpdateParentMojo

@Inject
public UpdateParentMojo(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.eclipse.aether.RepositorySystem repositorySystem,
 Map<String,org.apache.maven.wagon.Wagon> wagonMap,
 Map<String,ChangeRecorder> changeRecorders)

Method Details

update

protected void update(MutableXMLStreamReader pom)
               throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException,
XMLStreamException,
VersionRetrievalException

Description copied from class: AbstractVersionsUpdaterMojo

Updates the pom.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - the pom to update.

Throws:

org.apache.maven.plugin.MojoExecutionException - when things go wrong

org.apache.maven.plugin.MojoFailureException - when things go wrong in a very bad way

XMLStreamException - when things go wrong with XML streaming

VersionRetrievalException - if version retrieval goes wrong

Since:

1.0-alpha-1

See Also:

• AbstractVersionsUpdaterMojo.update(MutableXMLStreamReader)

resolveTargetVersion

protected org.apache.maven.artifact.versioning.ArtifactVersion resolveTargetVersion()
                                                                             throws org.apache.maven.plugin.MojoExecutionException,
VersionRetrievalException,
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException,
InvalidSegmentException

Throws:

org.apache.maven.plugin.MojoExecutionException

VersionRetrievalException

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

InvalidSegmentException