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:

ContextEnabled, Mojo

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

Aggregates the Maven project and its child modules.

Is defined by the goal name:

update-child-modules

Requires a direct invocation by the user:

true

Requires a Maven project to run:

true

Field Summary

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

allowSnapshots, artifactFactory, artifactMetadataSource, comparisonMethod, localRepository, pathTranslator, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, resolver, session

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

ROLE

Constructor Summary

UpdateChildModulesMojo()

Method Summary

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, getExpressionEvaluator, getHelper, getProject, getPropertyValue, getVersionComparator, newModifiedPomXER, process, readFile, setProject, shouldApplyUpdate, 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

public UpdateChildModulesMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Called when this mojo is executed.

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractVersionsUpdaterMojo

Throws:

MojoExecutionException - when things go wrong.

MojoFailureException - when things go wrong.

update

protected void update(ModifiedPomXMLEventReader pom)
               throws MojoExecutionException,
                      MojoFailureException,
                      javax.xml.stream.XMLStreamException

Updates the pom file.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - The pom file to update.

Throws:

MojoExecutionException - when things go wrong.

MojoFailureException - when things go wrong.

javax.xml.stream.XMLStreamException - when things go wrong.