jenkins.scm.api.mixin

Interface ChangeRequestSCMHead2

All Superinterfaces:

ChangeRequestSCMHead, Comparable<SCMHead>, SCMHeadMixin, Serializable

public interface ChangeRequestSCMHead2
extends ChangeRequestSCMHead

Additional attributes of a ChangeRequestSCMHead that should have been in the original mixin but we are not targeting Java 8 so we cannot add the default methods to the interface and must have an ugly 2 class instead.

Since:

2.2.0

Nested Class Summary

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

SCMHeadMixin.Equality

Method Summary

Modifier and Type	Method and Description
ChangeRequestCheckoutStrategy	getCheckoutStrategy() Returns the ChangeRequestCheckoutStrategy of this ChangeRequestSCMHead.
String	getOriginName() Returns the name of the actual head on the source control system which may or may not be different from SCMHeadMixin.getName().

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

getId, getTarget

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

getName, getOrigin

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getCheckoutStrategy

@NonNull
ChangeRequestCheckoutStrategy getCheckoutStrategy()

Returns the ChangeRequestCheckoutStrategy of this ChangeRequestSCMHead.

Returns:

the ChangeRequestCheckoutStrategy.

getOriginName

@NonNull
String getOriginName()

Returns the name of the actual head on the source control system which may or may not be different from SCMHeadMixin.getName(). For example in GitHub or Bitbucket this method would return the name of the origin branch whereas SCMHeadMixin.getName() would return something like PR-24. It is perfectly acceptable for a SCM implementation to return the same value as SCMHeadMixin.getName() where the SCM implementation does not have a separate concept of origin name.

Returns:

the name this ChangeRequestSCMHead would have if the SCMSource were configured against the SCMHeadMixin.getOrigin() directly and the change request were be discoverable as a regular SCMHead or SCMHeadMixin.getName() if such a concept is not possible in the backing source control system.