org.apache.maven.scm.plugin

Class UpdateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.UpdateMojo

All Implemented Interfaces:

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

@Mojo(name="update",
      aggregator=true)
public class UpdateMojo
extends AbstractScmMojo

Update the local working copy with the latest source from the configured scm url.

Field Summary

Fields

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

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

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdateMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

Methods inherited from class org.apache.maven.scm.plugin.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 java.lang.Object

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

Field Detail

scmVersionType

@Parameter(property="scmVersionType")
private java.lang.String scmVersionType

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

scmVersion

@Parameter(property="scmVersion")
private java.lang.String scmVersion

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

revisionKey

@Parameter(property="revisionKey",
           defaultValue="scm.revision")
private java.lang.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.

runChangelog

@Parameter(property="runChangelog",
           defaultValue="false")
private boolean runChangelog

Run Changelog after update.

Constructor Detail

UpdateMojo

public UpdateMojo()

Method Detail

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