Class ExportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.ExportMojo

All Implemented Interfaces:

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

@Mojo(name="export",
      requiresProject=false)
public class ExportMojo
extends AbstractScmMojo

Get a fresh exported copy of the latest source from the configured scm url.

Field Summary

Fields

Modifier and Type	Field	Description
private File	exportDirectory	The directory to export the sources to.
private String	scmVersion	The version (revision number/branch name/tag name).
private String	scmVersionType	The version type (branch/tag/revision) of scmVersion.
private boolean	skipExportIfExists	Skip export if exportDirectory exists.

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
ExportMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
void	execute()
protected void	export()
protected File	getExportDirectory()
void	setExportDirectory(File exportDirectory)

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).

exportDirectory

@Parameter(property="exportDirectory",
           defaultValue="${project.build.directory}/export",
           required=true)
private File exportDirectory

The directory to export the sources to.

skipExportIfExists

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

Skip export if exportDirectory exists.

Constructor Details

ExportMojo

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

getExportDirectory

protected File getExportDirectory()

setExportDirectory

public void setExportDirectory(File exportDirectory)

export

protected void export()
               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException