Class UpdateSubprojectsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.UpdateSubprojectsMojo

All Implemented Interfaces:

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

@Mojo(name="update-subprojects")
public class UpdateSubprojectsMojo
extends AbstractScmMojo

Updates all projects in a multi project build. This is useful for users who have adopted the flat project structure where the aggregator project is a sibling of the sub projects rather than sitting in the parent directory.

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.maven.project.MavenProject	project	The Maven project.
private String	revisionKey	The project property where to store the revision name.
private String	scmVersion	The version (revision number/branch name/tag name).
private String	scmVersionType	The version type (branch/tag/revision) of scmVersion.

Fields inherited from class AbstractScmMojo

VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateSubprojectsMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class AbstractScmMojo

checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

scmVersionType

@Parameter(property="scmVersionType")
private String scmVersionType

The version type (branch/tag/revision) of scmVersion.

scmVersion

@Parameter(property="scmVersion")
private String scmVersion

The version (revision number/branch name/tag name).

revisionKey

@Parameter(property="revisionKey",
           defaultValue="scm.revision")
private String revisionKey

The project property where to store the revision name.

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
private org.apache.maven.project.MavenProject project

The Maven project.

Constructor Details

UpdateSubprojectsMojo

@Inject
public UpdateSubprojectsMojo(ScmManager manager,
 org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Details

execute

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

Specified by:

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

Overrides:

execute in class AbstractScmMojo

Throws:

org.apache.maven.plugin.MojoExecutionException