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:

ContextEnabled, Mojo

Direct Known Subclasses:

BootstrapMojo

public class CheckoutMojo
extends AbstractScmMojo

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

Version:

$Id: CheckoutMojo.java 928132 2010-03-27 03:39:51Z dantran $

Author:

Emmanuel Venisse

Requires a Maven project to run:

false

Is defined by the goal name:

checkout

Field Summary

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

ROLE

Constructor Summary

CheckoutMojo()

Method Summary

protected org.apache.maven.scm.ScmResult	checkout()
void	execute()
protected File	getCheckoutDirectory()
protected org.apache.maven.scm.ScmResult	getCheckoutResult()
void	setCheckoutDirectory(File checkoutDirectory)

Methods inherited from class org.apache.maven.scm.plugin.AbstractScmMojo

checkResult, 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

Constructor Detail

CheckoutMojo

public CheckoutMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractScmMojo

Throws:

MojoExecutionException

getCheckoutDirectory

protected File getCheckoutDirectory()

setCheckoutDirectory

public void setCheckoutDirectory(File checkoutDirectory)

checkout

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

Throws:

MojoExecutionException

getCheckoutResult

protected org.apache.maven.scm.ScmResult getCheckoutResult()