Package hudson.plugins.mercurial

Class MercurialSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.mercurial.MercurialSCM

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>, Serializable

public class MercurialSCM
extends SCM
implements Serializable

Mercurial SCM.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MercurialSCM.DescriptorImpl
static enum	MercurialSCM.RevisionType

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor	Description
MercurialSCM(String source)
MercurialSCM(String installation, String source, MercurialSCM.RevisionType revisionType, String revision, String modules, String subdir, HgBrowser browser, boolean clean, String credentialsId)	Deprecated.
MercurialSCM(String installation, String source, MercurialSCM.RevisionType revisionType, String revision, String modules, String subdir, HgBrowser browser, boolean clean, String credentialsId, boolean disableChangeLog)	Deprecated.
MercurialSCM(String installation, String source, String branch, String modules, String subdir, HgBrowser browser, boolean clean)	Deprecated.
MercurialSCM(String installation, String source, String branch, String modules, String subdir, HgBrowser browser, boolean clean, String credentialsId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	buildEnvironment(Run<?,?> build, Map<String,String> env)
SCMRevisionState	calcRevisionsFromBuild(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
void	checkout(Run<?,?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline)
PollingResult	compareRemoteRevisionWith(Job<?,?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState _baseline)
ChangeLogParser	createChangeLogParser()
static MercurialInstallation	findInstallation(String name)
String	getBranch()	Deprecated.
HgBrowser	getBrowser()
String	getCredentialsId()
MercurialSCM.DescriptorImpl	getDescriptor()
String	getInstallation()
String	getKey()
FilePath	getModuleRoot(FilePath workspace, AbstractBuild build)
String	getModules()
String	getRevision()
MercurialSCM.RevisionType	getRevisionType()
String	getSource()	Gets the source repository path.
String	getSubdir()
RepositoryBrowser<?>	guessBrowser()
boolean	isClean()	True if we want clean check out each time.
boolean	isDisableChangeLog()
boolean	requiresWorkspaceForPolling()
final void	setBrowser(HgBrowser browser)
final void	setClean(boolean clean)
final void	setCredentialsId(String credentialsId)
final void	setDisableChangeLog(boolean disableChangeLog)
final void	setInstallation(String installation)
final void	setModules(String modules)
final void	setRevision(String revision)
final void	setRevisionType(MercurialSCM.RevisionType revisionType)
final void	setSubdir(String subdir)

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getEffectiveBrowser, getModuleRoot, getModuleRoots, getModuleRoots, getType, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, supportsPolling

Methods inherited from class java.lang.Object

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

Constructor Details

MercurialSCM

@DataBoundConstructor
public MercurialSCM(String source)

MercurialSCM

@Deprecated
public MercurialSCM(String installation,
 String source,
 String branch,
 String modules,
 String subdir,
 HgBrowser browser,
 boolean clean)

Deprecated.

MercurialSCM

@Deprecated
public MercurialSCM(String installation,
 String source,
 String branch,
 String modules,
 String subdir,
 HgBrowser browser,
 boolean clean,
 String credentialsId)

Deprecated.

MercurialSCM

@Deprecated
public MercurialSCM(String installation,
 String source,
 @NonNull
 MercurialSCM.RevisionType revisionType,
 @NonNull
 String revision,
 String modules,
 String subdir,
 HgBrowser browser,
 boolean clean,
 String credentialsId)

Deprecated.

MercurialSCM

@Deprecated
public MercurialSCM(String installation,
 String source,
 @NonNull
 MercurialSCM.RevisionType revisionType,
 @NonNull
 String revision,
 String modules,
 String subdir,
 HgBrowser browser,
 boolean clean,
 String credentialsId,
 boolean disableChangeLog)

Deprecated.

Method Details

getInstallation

public String getInstallation()

setInstallation

@DataBoundSetter
public final void setInstallation(String installation)

getSource

public String getSource()

Gets the source repository path. Either URL or local file path.

getKey

public String getKey()

Overrides:

getKey in class SCM

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public final void setCredentialsId(String credentialsId)

isDisableChangeLog

public boolean isDisableChangeLog()

setDisableChangeLog

@DataBoundSetter
public final void setDisableChangeLog(boolean disableChangeLog)

getRevisionType

@NonNull
public MercurialSCM.RevisionType getRevisionType()

setRevisionType

@DataBoundSetter
public final void setRevisionType(@NonNull
 MercurialSCM.RevisionType revisionType)

getRevision

@NonNull
public String getRevision()

setRevision

@DataBoundSetter
public final void setRevision(@NonNull
 String revision)

getBranch

@Deprecated
public String getBranch()

Deprecated.

getSubdir

public String getSubdir()

setSubdir

@DataBoundSetter
public final void setSubdir(String subdir)

getBrowser

public HgBrowser getBrowser()

Overrides:

getBrowser in class SCM

setBrowser

@DataBoundSetter
public final void setBrowser(HgBrowser browser)

guessBrowser

public RepositoryBrowser<?> guessBrowser()

Overrides:

guessBrowser in class SCM

isClean

public boolean isClean()

True if we want clean check out each time. This means deleting everything in the repository checkout (except .hg).

setClean

@DataBoundSetter
public final void setClean(boolean clean)

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(Run<?,?> build,
 FilePath workspace,
 Launcher launcher,
 TaskListener listener)
                                        throws IOException,
InterruptedException

Overrides:

calcRevisionsFromBuild in class SCM

Throws:

IOException

InterruptedException

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class SCM

compareRemoteRevisionWith

public PollingResult compareRemoteRevisionWith(Job<?,?> project,
 Launcher launcher,
 FilePath workspace,
 TaskListener listener,
 SCMRevisionState _baseline)
                                        throws IOException,
InterruptedException

Overrides:

compareRemoteRevisionWith in class SCM

Throws:

IOException

InterruptedException

findInstallation

@CheckForNull
public static MercurialInstallation findInstallation(String name)

checkout

public void checkout(Run<?,?> build,
 Launcher launcher,
 FilePath workspace,
 TaskListener listener,
 File changelogFile,
 SCMRevisionState baseline)
              throws IOException,
InterruptedException

Overrides:

checkout in class SCM

Throws:

IOException

InterruptedException

buildEnvironment

public void buildEnvironment(@NonNull
 Run<?,?> build,
 @NonNull
 Map<String,String> env)

Overrides:

buildEnvironment in class SCM

createChangeLogParser

public ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class SCM

getModuleRoot

public FilePath getModuleRoot(FilePath workspace,
 AbstractBuild build)

Overrides:

getModuleRoot in class SCM

getDescriptor

public MercurialSCM.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<SCM>

Overrides:

getDescriptor in class SCM

getModules

public String getModules()

setModules

@DataBoundSetter
public final void setModules(String modules)