Package org.apache.maven.scm.plugin

Class AbstractScmMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AddMojo, BranchMojo, ChangeLogMojo, CheckinMojo, CheckLocalModificationsMojo, CheckoutMojo, DiffMojo, EditMojo, ExportMojo, ListMojo, RemoveMojo, StatusMojo, TagMojo, UnEditMojo, UntagMojo, UpdateMojo, UpdateSubprojectsMojo, ValidateMojo

public abstract class AbstractScmMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Emmanuel Venisse, Olivier Lamy

Field Summary

Fields

Modifier and Type	Field	Description
protected static String[]	VALID_VERSION_TYPES
protected static String	VERSION_TYPE_BRANCH
protected static String	VERSION_TYPE_REVISION
protected static String	VERSION_TYPE_TAG

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScmMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
void	checkResult(ScmResult result)
void	execute()
File	getBasedir()
String	getConnectionUrl()
String	getExcludes()
ScmFileSet	getFileSet()
String	getIncludes()
ScmManager	getScmManager()
ScmRepository	getScmRepository()
ScmVersion	getScmVersion(String versionType, String version)
File	getWorkingDirectory()
protected void	handleExcludesIncludesAfterCheckoutAndExport(File checkoutDirectory)
protected void	setConnectionType(String connectionType)
void	setConnectionUrl(String connectionUrl)
void	setExcludes(String excludes)
void	setIncludes(String includes)
void	setWorkingDirectory(File workingDirectory)

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

VERSION_TYPE_BRANCH

protected static final String VERSION_TYPE_BRANCH

See Also:

Constant Field Values

VERSION_TYPE_REVISION

protected static final String VERSION_TYPE_REVISION

See Also:

Constant Field Values

VERSION_TYPE_TAG

protected static final String VERSION_TYPE_TAG

See Also:

Constant Field Values

VALID_VERSION_TYPES

protected static final String[] VALID_VERSION_TYPES

Constructor Detail

AbstractScmMojo

protected AbstractScmMojo(ScmManager manager,
                          org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

setConnectionType

protected void setConnectionType(String connectionType)

getConnectionUrl

public String getConnectionUrl()

setConnectionUrl

public void setConnectionUrl(String connectionUrl)

getWorkingDirectory

public File getWorkingDirectory()

getBasedir

public File getBasedir()

setWorkingDirectory

public void setWorkingDirectory(File workingDirectory)

getScmManager

public ScmManager getScmManager()

getFileSet

public ScmFileSet getFileSet()
                      throws IOException

Throws:

IOException

getScmRepository

public ScmRepository getScmRepository()
                               throws ScmException

Throws:

ScmException

checkResult

public void checkResult(ScmResult result)
                 throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getIncludes

public String getIncludes()

setIncludes

public void setIncludes(String includes)

getExcludes

public String getExcludes()

setExcludes

public void setExcludes(String excludes)

getScmVersion

public ScmVersion getScmVersion(String versionType,
                                String version)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

handleExcludesIncludesAfterCheckoutAndExport

protected void handleExcludesIncludesAfterCheckoutAndExport(File checkoutDirectory)
                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException