org.codehaus.mojo.versions

Class UpdatePropertyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDependencyUpdaterMojo

org.codehaus.mojo.versions.UpdatePropertiesMojoBase

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 UpdatePropertiesMojoBase

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 String	property A property to update.

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

allowDowngrade, allowIncrementalUpdates, allowMajorUpdates, allowMinorUpdates, autoLinkItems, includeParent

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

SNAPSHOT_REGEX

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

aetherRepositorySystem, allowSnapshots, ignoredVersions, project, reactorProjects, repositorySystem, ruleSet, session, wagonMap

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

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdatePropertyMojo(org.apache.maven.repository.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystem aetherRepositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, Map<String,org.codehaus.mojo.versions.api.recording.ChangeRecorder> changeRecorders)

Method Summary

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

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

update

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

findArtifact, getParentDependency, hasIncludes, isExcludeReactor, isHandledByProperty, isIncluded, isProcessingDependencies, isProcessingDependencyManagement, isProcessingParent, isProducedByReactor, separatePatterns, toArtifact, toArtifact, toString, toString, updateDependencyVersion

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

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getPropertyValue, getVersion, newModifiedPomXER, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, updatePropertyToNewestVersion, validateInput, 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

Constructor Detail

UpdatePropertyMojo

@Inject
public UpdatePropertyMojo(org.apache.maven.repository.RepositorySystem repositorySystem,
                                  org.eclipse.aether.RepositorySystem aetherRepositorySystem,
                                  Map<String,org.apache.maven.wagon.Wagon> wagonMap,
                                  Map<String,org.codehaus.mojo.versions.api.recording.ChangeRecorder> changeRecorders)

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)