Package com.atlassian.bamboo.vcs.configurator

Interface VcsBranchConfigurator

All Known Implementing Classes:

BitbucketCloudBranchConfigurator, BitbucketServerBranchConfigurator, GitBranchConfigurator, GitHubBranchConfigurator, SvnBranchConfigurator

public interface VcsBranchConfigurator

Class handling branch part of repository configuration.

Since:

5.14

Method Summary

Modifier and Type	Method	Description
@NotNull VcsBranch	createVcsBranchFromName(@NotNull String name)	Create new vcs branch instance with given name
default @NotNull VcsBranch	createVcsBranchFromNameForForkWorkflow(@NotNull String branchName, @NotNull String pullRequestKey)	Create new vcs branch instance with given branch name and pull requests key.
default @NotNull Map<String,String>	generateConfigMap(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsBranchDefinition previousBranchDefinition)	Deprecated. since 5.15 use invalid @link {@link #generateConfigMap(ActionParametersMap, VcsBranchDefinition, Map
default @NotNull Map<String,String>	generateConfigMap(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsBranchDefinition previousBranchDefinition, @NotNull Map<String,String> locationConfiguration)
@NotNull VcsBranch	getVcsBranchFromConfig(@NotNull Map<String,String> configMap)	Return branch name according to provided config.
void	populateContextForCreate(@NotNull Map<String,Object> context)
void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull VcsBranchDefinition branchDefinition)
void	populateContextForView(@NotNull Map<String,Object> context, @NotNull VcsBranchDefinition branchDefinition)
@NotNull Map<String,String>	setVcsBranchInConfig(@NotNull Map<String,String> configMap, @NotNull VcsBranch vcsBranch)	Modify config map by setting branch to provided one.
void	validate(@NotNull ActionParametersMap actionParametersMap, @NotNull ErrorCollection errorCollection)

Method Details

populateContextForCreate

void populateContextForCreate(@NotNull
 @NotNull Map<String,Object> context)

populateContextForEdit

void populateContextForEdit(@NotNull
 @NotNull Map<String,Object> context,
 @NotNull
 @NotNull VcsBranchDefinition branchDefinition)

populateContextForView

void populateContextForView(@NotNull
 @NotNull Map<String,Object> context,
 @NotNull
 @NotNull VcsBranchDefinition branchDefinition)

validate

void validate(@NotNull
 @NotNull ActionParametersMap actionParametersMap,
 @NotNull
 @NotNull ErrorCollection errorCollection)

generateConfigMap

@Deprecated
@NotNull
default @NotNull Map<String,String> generateConfigMap(@NotNull
 @NotNull ActionParametersMap actionParametersMap,
 @Nullable
 @Nullable VcsBranchDefinition previousBranchDefinition)

Deprecated.

since 5.15 use

invalid @link

{@link #generateConfigMap(ActionParametersMap, VcsBranchDefinition, Map

Parameters:

actionParametersMap -

previousBranchDefinition -

generateConfigMap

@NotNull
default @NotNull Map<String,String> generateConfigMap(@NotNull
 @NotNull ActionParametersMap actionParametersMap,
 @Nullable
 @Nullable VcsBranchDefinition previousBranchDefinition,
 @NotNull
 @NotNull Map<String,String> locationConfiguration)

Parameters:

actionParametersMap -

previousBranchDefinition -

locationConfiguration - - actual server configuration that can be checked when generating branch configuration

Since:

5.15

getVcsBranchFromConfig

@NotNull
@NotNull VcsBranch getVcsBranchFromConfig(@NotNull
 @NotNull Map<String,String> configMap)

Return branch name according to provided config.

Parameters:

configMap -

setVcsBranchInConfig

@NotNull
@NotNull Map<String,String> setVcsBranchInConfig(@NotNull
 @NotNull Map<String,String> configMap,
 @NotNull
 @NotNull VcsBranch vcsBranch)

Modify config map by setting branch to provided one.

Parameters:

configMap -

vcsBranch -

createVcsBranchFromName

@NotNull
@NotNull VcsBranch createVcsBranchFromName(@NotNull
 @NotNull String name)

Create new vcs branch instance with given name

Parameters:

name -

Returns:

createVcsBranchFromNameForForkWorkflow

@NotNull
default @NotNull VcsBranch createVcsBranchFromNameForForkWorkflow(@NotNull
 @NotNull String branchName,
 @NotNull
 @NotNull String pullRequestKey)

Create new vcs branch instance with given branch name and pull requests key.

Parameters:

branchName -

pullRequestKey -

Returns: