VcsVariableGenerator (Atlassian Bamboo 9.5.1 API)

All Known Implementing Classes:

BitbucketCloudVariableGenerator, BitbucketServerVariableGenerator, GitHubVariableGenerator, GitVariableGenerator, LegacyVariableGenerator, SvnVariableGenerator
```
public interface VcsVariableGenerator
```
Allows generation of custom repository variables.

Since:

5.14

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default @Nullable String`	`getLegacyPrefix()`	Deprecated. since 5.14 the method exist only to provide backward compatibility with deprecated behaviour of `CustomVariableProviderRepository`
`@NotNull Map<String,String>`	`getPlanRepositoryVariables(@NotNull VcsRepositoryData vcsRepositoryData)`	Return a map containing name->value mapping of the plan repository format variables.

- Method Detail
  - getLegacyPrefix
```
@Deprecated
@Nullable
default @Nullable String getLegacyPrefix()
```
    Deprecated.
    since 5.14 the method exist only to provide backward compatibility with deprecated behaviour of CustomVariableProviderRepository
    
    Provides default prefix for generated variables.
  - getPlanRepositoryVariables
```
@NotNull
@NotNull Map<String,String> getPlanRepositoryVariables(@NotNull
                                                             @NotNull VcsRepositoryData vcsRepositoryData)
```
    Return a map containing name->value mapping of the plan repository format variables.
    Null values will be filtered out so it's safe to put them in the map.
    
    Parameters:
    
    vcsRepositoryData - definition of repository to generate variables for
    
    Returns:
    
    Map with variable substitutions