Package org.jenkinsci.plugins.workflow.multibranch

Class SCMVar

java.lang.Object

org.jenkinsci.plugins.workflow.cps.GlobalVariable

org.jenkinsci.plugins.workflow.multibranch.SCMVar

All Implemented Interfaces:

ExtensionPoint

@Extension
public class SCMVar
extends org.jenkinsci.plugins.workflow.cps.GlobalVariable

Adds an scm global variable to the script. This makes it possible to run checkout scm to get your project sources in the right branch.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SCMVar.Pickler	Ensures that scm is saved in its XML representation.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

ALL

Constructor Summary

Constructors

Constructor	Description
SCMVar()

Method Summary

Modifier and Type	Method	Description
String	getName()
SCM	getValue(org.jenkinsci.plugins.workflow.cps.CpsScript script)

Methods inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

byName, forJob, forRun

Methods inherited from class java.lang.Object

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

Constructor Details

SCMVar

public SCMVar()

Method Details

getName

@NonNull
public String getName()

Specified by:

getName in class org.jenkinsci.plugins.workflow.cps.GlobalVariable

getValue

@NonNull
public SCM getValue(@NonNull
 org.jenkinsci.plugins.workflow.cps.CpsScript script)
             throws Exception

Specified by:

getValue in class org.jenkinsci.plugins.workflow.cps.GlobalVariable

Throws:

Exception