Package org.jenkinsci.plugins.github.pullrequest.data

Enum GitHubPREnv

java.lang.Object

java.lang.Enum<GitHubPREnv>

org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv

All Implemented Interfaces:

GitHubEnv<GitHubPRCause>, Serializable, Comparable<GitHubPREnv>

public enum GitHubPREnv
extends Enum<GitHubPREnv>
implements GitHubEnv<GitHubPRCause>

Author:

lanwen (Merkushev Kirill)

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHOR_EMAIL
BODY
CAUSE_SKIP
COMMENT_AUTHOR_EMAIL
COMMENT_AUTHOR_NAME
COMMENT_BODY
COMMENT_BODY_MATCH
COMMIT_AUTHOR_EMAIL
COMMIT_AUTHOR_NAME
COND_REF
HEAD_SHA
LABELS
NUMBER
SHORT_DESC
SOURCE_BRANCH
SOURCE_REPO_OWNER
STATE
TARGET_BRANCH
TITLE
TRIGGER_SENDER_AUTHOR
TRIGGER_SENDER_EMAIL
URL

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREFIX

Method Summary

Modifier and Type	Method	Description
void	addParam(GitHubPRCause cause, List<ParameterValue> params)
static void	getParams(GitHubPRCause cause, List<ParameterValue> params)
String	toString()
static GitHubPREnv	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GitHubPREnv[]	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

Methods inherited from interface com.github.kostyasha.github.integration.generic.GitHubEnv

param, param

Enum Constant Detail

TRIGGER_SENDER_AUTHOR

public static final GitHubPREnv TRIGGER_SENDER_AUTHOR

TRIGGER_SENDER_EMAIL

public static final GitHubPREnv TRIGGER_SENDER_EMAIL

COMMIT_AUTHOR_NAME

public static final GitHubPREnv COMMIT_AUTHOR_NAME

COMMIT_AUTHOR_EMAIL

public static final GitHubPREnv COMMIT_AUTHOR_EMAIL

TARGET_BRANCH

public static final GitHubPREnv TARGET_BRANCH

SOURCE_BRANCH

public static final GitHubPREnv SOURCE_BRANCH

AUTHOR_EMAIL

public static final GitHubPREnv AUTHOR_EMAIL

BODY

public static final GitHubPREnv BODY

SHORT_DESC

public static final GitHubPREnv SHORT_DESC

TITLE

public static final GitHubPREnv TITLE

URL

public static final GitHubPREnv URL

SOURCE_REPO_OWNER

public static final GitHubPREnv SOURCE_REPO_OWNER

HEAD_SHA

public static final GitHubPREnv HEAD_SHA

COND_REF

public static final GitHubPREnv COND_REF

CAUSE_SKIP

public static final GitHubPREnv CAUSE_SKIP

NUMBER

public static final GitHubPREnv NUMBER

STATE

public static final GitHubPREnv STATE

COMMENT_AUTHOR_NAME

public static final GitHubPREnv COMMENT_AUTHOR_NAME

COMMENT_AUTHOR_EMAIL

public static final GitHubPREnv COMMENT_AUTHOR_EMAIL

COMMENT_BODY

public static final GitHubPREnv COMMENT_BODY

COMMENT_BODY_MATCH

public static final GitHubPREnv COMMENT_BODY_MATCH

LABELS

public static final GitHubPREnv LABELS

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

addParam

public void addParam(GitHubPRCause cause,
                     List<ParameterValue> params)

Specified by:

addParam in interface GitHubEnv<GitHubPRCause>

toString

public String toString()

Overrides:

toString in class Enum<GitHubPREnv>

getParams

public static void getParams(GitHubPRCause cause,
                             List<ParameterValue> params)