org.codehaus.mojo.versions

Class UpdateChildModulesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.UpdateChildModulesMojo

All Implemented Interfaces:

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

@Mojo(name="update-child-modules",
      aggregator=true,
      threadSafe=true)
public class UpdateChildModulesMojo
extends AbstractVersionsUpdaterMojo

Scans the current projects child modules, updating the versions of any which use the current project to the version of the current project.

Since:

1.0-alpha-2

Author:

Stephen Connolly

Field Summary

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
UpdateChildModulesMojo(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
void	execute() Called when this mojo is executed.
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom file.

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

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

Constructor Detail

UpdateChildModulesMojo

@Inject
public UpdateChildModulesMojo(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

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Called when this mojo is executed.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractVersionsUpdaterMojo

Throws:

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

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

update

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

Updates the pom file.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - The pom file to update.

Throws:

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

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

XMLStreamException - when things go wrong.