org.codehaus.mojo.versions

Class UpdatePropertyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.UpdatePropertyMojo

All Implemented Interfaces:

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

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

Sets a property to the latest version in a given range of associated artifacts.

Since:

1.3

Author:

Eric Pabst

Field Summary

Fields

Modifier and Type	Field and Description
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 String	property A property to update.

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

allowSnapshots, artifactMetadataSource, artifactResolver, ignoredVersions, localRepository, project, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, repositorySystem, ruleSet, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdatePropertyMojo(org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.artifact.manager.WagonManager wagonManager, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver)

Method Summary

Modifier and Type	Method and Description
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

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

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getPropertyValue, getVersion, newModifiedPomXER, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, updatePropertyToNewestVersion, writeFile

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 Detail

property

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

A property to update.

Since:

1.3

allowMajorUpdates

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

Whether to allow the major version number to be changed.

Since:

2.4

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.4

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.4

Constructor Detail

UpdatePropertyMojo

@Inject
public UpdatePropertyMojo(org.apache.maven.repository.RepositorySystem repositorySystem,
                                  org.apache.maven.project.MavenProjectBuilder projectBuilder,
                                  org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                                  org.apache.maven.artifact.manager.WagonManager wagonManager,
                                  org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver)

Method Detail

update

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

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

Since:

1.0-alpha-1

See Also:

AbstractVersionsUpdaterMojo.update(ModifiedPomXMLEventReader)