Package com.atlassian.bamboo.plan.branch

Enum PlanBranchWorkflow

java.lang.Object

java.lang.Enum<PlanBranchWorkflow>

com.atlassian.bamboo.plan.branch.PlanBranchWorkflow

All Implemented Interfaces:

Serializable, Comparable<PlanBranchWorkflow>

public enum PlanBranchWorkflow
extends Enum<PlanBranchWorkflow>

Types of workflows for automatic plan branch management.

Since:

6.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRANCH_WORKFLOW	Branch workflow indicates that Bamboo will react on VCS branches being created and/or deleted in the repository when managing plan branches.
FORK_ENABLED_PULL_REQUEST_WORKFLOW	Pull request (from both master repository and forked repositories) workflow indicates that Bamboo will react on pull requests being created and/or deleted in the repository when managing plan branches.
MANUAL_WORKFLOW	Manual workflow indicates that Bamboo will not react on VCS branches nor pull requests being created and/or deleted in the repository when managing plan branches.
PULL_REQUEST_WORKFLOW	Pull request workflow indicates that Bamboo will react on pull requests being created and/or deleted in the repository when managing plan branches.

Method Summary

Modifier and Type	Method	Description
static PlanBranchWorkflow	defaultValue()	Returns the default workflow.
static @NotNull PlanBranchWorkflow	fromKey(@NotNull String key)	Returns an instance of PlanBranchWorkflow based on the passed key.
@NotNull Set<BranchIntegrationStrategy>	getIntegrationStrategies()	Allowed integration strategies for this workflow.
@NotNull String	getKey()	Key to be used for storing this enum in any configuration as string.
boolean	isOneOfPullRequestWorkflows()
static PlanBranchWorkflow	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PlanBranchWorkflow[]	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

BRANCH_WORKFLOW

public static final PlanBranchWorkflow BRANCH_WORKFLOW

Branch workflow indicates that Bamboo will react on VCS branches being created and/or deleted in the repository when managing plan branches.

MANUAL_WORKFLOW

public static final PlanBranchWorkflow MANUAL_WORKFLOW

Manual workflow indicates that Bamboo will not react on VCS branches nor pull requests being created and/or deleted in the repository when managing plan branches.

PULL_REQUEST_WORKFLOW

public static final PlanBranchWorkflow PULL_REQUEST_WORKFLOW

Pull request workflow indicates that Bamboo will react on pull requests being created and/or deleted in the repository when managing plan branches. This workflow does not let perform pull requests from forked repositories.

FORK_ENABLED_PULL_REQUEST_WORKFLOW

public static final PlanBranchWorkflow FORK_ENABLED_PULL_REQUEST_WORKFLOW

Pull request (from both master repository and forked repositories) workflow indicates that Bamboo will react on pull requests being created and/or deleted in the repository when managing plan branches.

Method Detail

values

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

Returns:

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

valueOf

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

defaultValue

public static PlanBranchWorkflow defaultValue()

Returns the default workflow.

fromKey

@NotNull
public static @NotNull PlanBranchWorkflow fromKey(@NotNull
                                                  @NotNull String key)

Returns an instance of PlanBranchWorkflow based on the passed key.

Parameters:

key - key of the workflow

Returns:

instance of plan branching workflow

Throws:

IllegalArgumentException - if the key does not match any known workflow

getKey

@NotNull
public @NotNull String getKey()

Key to be used for storing this enum in any configuration as string.

getIntegrationStrategies

@NotNull
public @NotNull Set<BranchIntegrationStrategy> getIntegrationStrategies()

Allowed integration strategies for this workflow.

isOneOfPullRequestWorkflows

public boolean isOneOfPullRequestWorkflows()