org.apache.maven.scm.plugin

Class CheckoutMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.CheckoutMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BootstrapMojo

@Mojo(name="checkout",
      requiresProject=false)
public class CheckoutMojo
extends AbstractScmMojo

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	checkoutDirectory The directory to checkout the sources to for the bootstrap and checkout goals.
private ScmResult	checkoutResult allow extended mojo (ie BootStrap ) to see checkout result
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.
private boolean	skipCheckoutIfExists Skip checkout if checkoutDirectory exists.
private boolean	useExport Use Export instead of checkout

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CheckoutMojo()

Method Summary

Modifier and Type	Method and Description
protected ScmResult	checkout()
void	execute()
protected java.io.File	getCheckoutDirectory()
protected ScmResult	getCheckoutResult()
private void	prepareOutputDirectory(java.io.File ouputDirectory)
void	setCheckoutDirectory(java.io.File checkoutDirectory)

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

useExport

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

Use Export instead of checkout

checkoutDirectory

@Parameter(property="checkoutDirectory",
           defaultValue="${project.build.directory}/checkout")
private java.io.File checkoutDirectory

The directory to checkout the sources to for the bootstrap and checkout goals.

skipCheckoutIfExists

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

Skip checkout if checkoutDirectory exists.

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

checkoutResult

private ScmResult checkoutResult

allow extended mojo (ie BootStrap ) to see checkout result

Constructor Detail

CheckoutMojo

public CheckoutMojo()

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

getCheckoutDirectory

protected java.io.File getCheckoutDirectory()

setCheckoutDirectory

public void setCheckoutDirectory(java.io.File checkoutDirectory)

checkout

protected ScmResult checkout()
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

prepareOutputDirectory

private void prepareOutputDirectory(java.io.File ouputDirectory)
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCheckoutResult

protected ScmResult getCheckoutResult()