Package org.jenkinsci.plugins.github_branch_source

Class PullRequestSCMHead

java.lang.Object

jenkins.scm.api.SCMHead

org.jenkinsci.plugins.github_branch_source.PullRequestSCMHead

All Implemented Interfaces:

Serializable, Comparable<jenkins.scm.api.SCMHead>, jenkins.scm.api.mixin.ChangeRequestSCMHead, jenkins.scm.api.mixin.ChangeRequestSCMHead2, jenkins.scm.api.mixin.SCMHeadMixin

Direct Known Subclasses:

PullRequestSCMHead.FixMetadata, PullRequestSCMHead.FixOrigin

public class PullRequestSCMHead
extends jenkins.scm.api.SCMHead
implements jenkins.scm.api.mixin.ChangeRequestSCMHead2

Head corresponding to a pull request. Named like PR-123 or PR-123-merge or PR-123-head.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PullRequestSCMHead.FixMetadata	Deprecated. used for data migration.
static class	PullRequestSCMHead.FixMetadataMigration	Deprecated. used for data migration.
static class	PullRequestSCMHead.FixOrigin	Deprecated. used for data migration.
static class	PullRequestSCMHead.FixOriginMigration	Deprecated. used for data migration.

Nested classes/interfaces inherited from class jenkins.scm.api.SCMHead

jenkins.scm.api.SCMHead.HeadByItem

Nested classes/interfaces inherited from interface jenkins.scm.api.mixin.SCMHeadMixin

jenkins.scm.api.mixin.SCMHeadMixin.Equality

Field Summary

Fields inherited from class jenkins.scm.api.SCMHead

PRONOUN

Constructor Summary

Constructors

Constructor	Description
PullRequestSCMHead(String name, String sourceOwner, String sourceRepo, String sourceBranch, int number, BranchSCMHead target, jenkins.scm.api.SCMHeadOrigin origin, jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy strategy)

Method Summary

Modifier and Type	Method	Description
jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy	getCheckoutStrategy()
String	getId()
int	getNumber()
jenkins.scm.api.SCMHeadOrigin	getOrigin()
String	getOriginName()
String	getPronoun()
String	getSourceBranch()
String	getSourceOwner()
String	getSourceRepo()
BranchSCMHead	getTarget()
boolean	isMerge()	Whether we intend to build the merge of the PR head with the base branch.

Methods inherited from class jenkins.scm.api.SCMHead

compareTo, equals, getAction, getAllActions, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jenkins.scm.api.mixin.SCMHeadMixin

getName

Constructor Details

PullRequestSCMHead

public PullRequestSCMHead(@NonNull
 String name,
 String sourceOwner,
 String sourceRepo,
 String sourceBranch,
 int number,
 BranchSCMHead target,
 jenkins.scm.api.SCMHeadOrigin origin,
 jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy strategy)

Method Details

getPronoun

public String getPronoun()

Overrides:

getPronoun in class jenkins.scm.api.SCMHead

getNumber

public int getNumber()

isMerge

public boolean isMerge()

Whether we intend to build the merge of the PR head with the base branch.

Returns:

true if this is a merge PR head.

getCheckoutStrategy

@NonNull
public jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy getCheckoutStrategy()

Specified by:

getCheckoutStrategy in interface jenkins.scm.api.mixin.ChangeRequestSCMHead2

getId

@NonNull
public String getId()

Specified by:

getId in interface jenkins.scm.api.mixin.ChangeRequestSCMHead

getTarget

@NonNull
public BranchSCMHead getTarget()

Specified by:

getTarget in interface jenkins.scm.api.mixin.ChangeRequestSCMHead

getOriginName

@NonNull
public String getOriginName()

Specified by:

getOriginName in interface jenkins.scm.api.mixin.ChangeRequestSCMHead2

getSourceOwner

public String getSourceOwner()

getSourceBranch

public String getSourceBranch()

getSourceRepo

public String getSourceRepo()

getOrigin

@NonNull
public jenkins.scm.api.SCMHeadOrigin getOrigin()

Specified by:

getOrigin in interface jenkins.scm.api.mixin.SCMHeadMixin

Overrides:

getOrigin in class jenkins.scm.api.SCMHead