com.atlassian.bitbucket.pull

Enum PullRequestCommitMessageTemplateVariable

java.lang.Object

java.lang.Enum<PullRequestCommitMessageTemplateVariable>

com.atlassian.bitbucket.pull.PullRequestCommitMessageTemplateVariable

All Implemented Interfaces:

Serializable, Comparable<PullRequestCommitMessageTemplateVariable>

public enum PullRequestCommitMessageTemplateVariable
extends Enum<PullRequestCommitMessageTemplateVariable>

Variables that are valid for substitution when rendering a PullRequestCommitMessageTemplate

Since:

8.12

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROVERS Comma separated list of names of people that approved.
CROSS_REPO_PR_REPO If the pull request is a cross repository pull request this variable contains the source project and repository slug.
DESCRIPTION The pull request description
FROM_PROJECT_KEY The project key for the source project
FROM_REF_NAME The name of the ref (branch/tag) to merge changes from
FROM_REPO_SLUG The slug of the source repository
ID The pull request ID
TITLE Pull request title
TO_PROJECT_KEY The project key for the target project
TO_REF_NAME The name of the ref (branch) to merge changes into
TO_REPO_SLUG The slug of the target repository

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getVariable()
String	toString() The format of the returned String is not considered stable and may change from release to release.
static PullRequestCommitMessageTemplateVariable	valueOf(String name) Returns the enum constant of this type with the specified name.
static PullRequestCommitMessageTemplateVariable[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPROVERS

public static final PullRequestCommitMessageTemplateVariable APPROVERS

Comma separated list of names of people that approved. Empty string if there are no approvals

ID

public static final PullRequestCommitMessageTemplateVariable ID

The pull request ID

CROSS_REPO_PR_REPO

public static final PullRequestCommitMessageTemplateVariable CROSS_REPO_PR_REPO

If the pull request is a cross repository pull request this variable contains the source project and repository slug.

If it is not a cross repository pull request this variable resolves to an empty string

DESCRIPTION

public static final PullRequestCommitMessageTemplateVariable DESCRIPTION

The pull request description

FROM_PROJECT_KEY

public static final PullRequestCommitMessageTemplateVariable FROM_PROJECT_KEY

The project key for the source project

FROM_REF_NAME

public static final PullRequestCommitMessageTemplateVariable FROM_REF_NAME

The name of the ref (branch/tag) to merge changes from

FROM_REPO_SLUG

public static final PullRequestCommitMessageTemplateVariable FROM_REPO_SLUG

The slug of the source repository

TITLE

public static final PullRequestCommitMessageTemplateVariable TITLE

Pull request title

TO_PROJECT_KEY

public static final PullRequestCommitMessageTemplateVariable TO_PROJECT_KEY

The project key for the target project

TO_REF_NAME

public static final PullRequestCommitMessageTemplateVariable TO_REF_NAME

The name of the ref (branch) to merge changes into

TO_REPO_SLUG

public static final PullRequestCommitMessageTemplateVariable TO_REPO_SLUG

The slug of the target repository

Method Detail

values

public static PullRequestCommitMessageTemplateVariable[] 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 (PullRequestCommitMessageTemplateVariable c : PullRequestCommitMessageTemplateVariable.values())
    System.out.println(c);

Returns:

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

valueOf

public static PullRequestCommitMessageTemplateVariable 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

getName

public String getName()

Returns:

the name of the variable without any prefix

getVariable

public String getVariable()

Returns:

the full variable with prefix and suffix applied

toString

public String toString()

The format of the returned String is not considered stable and may change from release to release. If a consistent format is needed use getName() and getVariable() instead.

Overrides:

toString in class Enum<PullRequestCommitMessageTemplateVariable>

Returns:

a string representation of the variable