jenkins.scm.api.mixin

Enum ChangeRequestCheckoutStrategy

java.lang.Object

java.lang.Enum<ChangeRequestCheckoutStrategy>

jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy

All Implemented Interfaces:

Serializable, Comparable<ChangeRequestCheckoutStrategy>

public enum ChangeRequestCheckoutStrategy
extends Enum<ChangeRequestCheckoutStrategy>

The various strategies that can be used when checking out a change request.

Since:

2.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEAD The revision to be checked out will be independent of the revision of the ChangeRequestSCMHead.getTarget().
MERGE The revision to be checked out will be the result of applying a merge algorithm between the the revision of the change request and the revision of the ChangeRequestSCMHead.getTarget().

Method Summary

Modifier and Type	Method and Description
static ChangeRequestCheckoutStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChangeRequestCheckoutStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEAD

public static final ChangeRequestCheckoutStrategy HEAD

The revision to be checked out will be independent of the revision of the ChangeRequestSCMHead.getTarget(). For example, with GitHub, Bitbucket, etc this would correspond to checking out the Head revision of the PR.

MERGE

public static final ChangeRequestCheckoutStrategy MERGE

The revision to be checked out will be the result of applying a merge algorithm between the the revision of the change request and the revision of the ChangeRequestSCMHead.getTarget().

In the event that the merge operation cannot be completed then the checkout operation will fail.

It is assumed that the algorithm for merging is deterministic given the revision of the change request and the revision of the ChangeRequestSCMHead.getTarget()

Method Detail

values

public static ChangeRequestCheckoutStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChangeRequestCheckoutStrategy c : ChangeRequestCheckoutStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ChangeRequestCheckoutStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null