Package org.jenkinsci.plugins.workflow.steps.scm

Class SCMStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.scm.SCMStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

Direct Known Subclasses:

GenericSCMStep

public abstract class SCMStep
extends org.jenkinsci.plugins.workflow.steps.Step

A step which uses some kind of SCM.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SCMStep.SCMStepDescriptor
static class	SCMStep.StepExecutionImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SCMStep()

Method Summary

Modifier and Type	Method	Description
void	checkout(Run<?,?> run, FilePath workspace, TaskListener listener, Launcher launcher)
protected abstract SCM	createSCM()
boolean	isChangelog()
boolean	isPoll()
void	setChangelog(boolean changelog)
void	setPoll(boolean poll)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMStep

public SCMStep()

Method Detail

isPoll

public boolean isPoll()

setPoll

@DataBoundSetter
public void setPoll(boolean poll)

isChangelog

public boolean isChangelog()

setChangelog

@DataBoundSetter
public void setChangelog(boolean changelog)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception

createSCM

@NonNull
protected abstract SCM createSCM()

checkout

public final void checkout(Run<?,?> run,
                           FilePath workspace,
                           TaskListener listener,
                           Launcher launcher)
                    throws Exception

Throws:

Exception