com.atlassian.bamboo.vcs.configurator

Interface VcsBranchConfigurator

All Known Implementing Classes:

BitbucketCloudBranchConfigurator, BitbucketServerBranchConfigurator, GitBranchConfigurator, GitHubBranchConfigurator, LegacyBranchConfigurator, MercurialBranchConfigurator, SvnBranchConfigurator

public interface VcsBranchConfigurator

Class handling branch part of repository configuration.

Since:

5.14

Method Summary

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

Method Detail

populateContextForCreate

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

populateContextForEdit

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

populateContextForView

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

validate

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

generateConfigMap

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

Deprecated. since 5.15 use {@link #generateConfigMap(ActionParametersMap, VcsBranchDefinition, Map

Parameters:

actionParametersMap -

previousBranchDefinition -

generateConfigMap

@NotNull
default Map<String,String> generateConfigMap(@NotNull
                                                      ActionParametersMap actionParametersMap,
                                                      @Nullable
                                                      VcsBranchDefinition previousBranchDefinition,
                                                      @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
VcsBranch getVcsBranchFromConfig(@NotNull
                                          Map<String,String> configMap)

Return branch name according to provided config.

Parameters:

configMap -

setVcsBranchInConfig

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

Modify config map setting branch to provided one.

Parameters:

configMap -

vcsBranch -

createVcsBranchFromName

@NotNull
VcsBranch createVcsBranchFromName(@NotNull
                                           String name)

Create new vcs branch instance given it's name

Parameters:

name -

Returns: