java.lang.Object
- com.atlassian.bamboo.plugins.github.configurator.GitHubBranchConfigurator

All Implemented Interfaces:: VcsBranchConfigurator

public class GitHubBranchConfigurator
extends Object
implements VcsBranchConfigurator

Constructor Summary

Constructors
Constructor	Description
`GitHubBranchConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver, CustomVariableContext customVariableContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@NotNull VcsBranch`	`createVcsBranchFromName(@NotNull String name)`	Create new vcs branch instance with given name
`@NotNull VcsBranch`	`createVcsBranchFromNameForForkWorkflow(@NotNull String branchName, @NotNull String pullRequestKey)`	Create new vcs branch instance with given branch name and pull requests key.
`@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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.vcs.configurator.VcsBranchConfigurator
generateConfigMap

Constructor Detail

GitHubBranchConfigurator

@Inject
public GitHubBranchConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                CustomVariableContext customVariableContext)

Method Detail

populateContextForCreate

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

Specified by:: populateContextForCreate in interface VcsBranchConfigurator

populateContextForEdit

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

Specified by:: populateContextForEdit in interface VcsBranchConfigurator

populateContextForView

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

Specified by:: populateContextForView in interface VcsBranchConfigurator

validate

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

Specified by:: validate in interface VcsBranchConfigurator

getVcsBranchFromConfig
```
@NotNull
public @NotNull VcsBranch getVcsBranchFromConfig(@NotNull
                                                 @NotNull Map<String,String> configMap)
```
Description copied from interface: VcsBranchConfigurator

Return branch name according to provided config.

Specified by:

getVcsBranchFromConfig in interface VcsBranchConfigurator

setVcsBranchInConfig

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

Description copied from interface: VcsBranchConfigurator

Modify config map by setting branch to provided one.

Specified by:: setVcsBranchInConfig in interface VcsBranchConfigurator

createVcsBranchFromName
```
@NotNull
public @NotNull VcsBranch createVcsBranchFromName(@NotNull
                                                  @NotNull String name)
```
Description copied from interface: VcsBranchConfigurator

Create new vcs branch instance with given name

Specified by:

createVcsBranchFromName in interface VcsBranchConfigurator

Returns:

createVcsBranchFromNameForForkWorkflow

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

Description copied from interface: VcsBranchConfigurator

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

Specified by:: createVcsBranchFromNameForForkWorkflow in interface VcsBranchConfigurator
Returns:

generateConfigMap

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

Specified by:: generateConfigMap in interface VcsBranchConfigurator; locationConfiguration - - actual server configuration that can be checked when generating branch configuration

Class GitHubBranchConfigurator