com.atlassian.bamboo.vcs.export

Interface VcsRepositoryDataExporter<B extends com.atlassian.bamboo.specs.api.builders.repository.VcsRepository,P extends com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties>

All Known Implementing Classes:

BitbucketServerExporter, DefaultVcsRepositoryDataExporter, GitConfigurationExporter, LegacyRepositoryConfigurationExporter, NoOverridesVcsRepositoryDataExporter

@ExperimentalApi
public interface VcsRepositoryDataExporter<B extends com.atlassian.bamboo.specs.api.builders.repository.VcsRepository,P extends com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties>

Handles exporting of repository configuration into YAML.

Since:

5.15

Method Summary

Modifier and Type	Method and Description
B	appendBranchData(B builder, VcsBranchDefinition vcsBranchDefinition) Fill in the builder passed as the first argument with vcs branch data.
B	appendBranchDetectionOptions(B builder, VcsBranchDetectionOptions branchDetectionOptions) Fill in the builder passed as the first argument with branch detection configuration.
B	appendChangeDetectionOptions(B builder, VcsChangeDetectionOptions changeDetectionOptions) Fill in the builder passed as the first argument with change detection configuration.
B	appendLocationData(B builder, VcsLocationDefinition vcsLocationDefinition) Fill in the builder passed as the first argument with vcs server data.
B	getEntityPropertiesBuilder(VcsRepositoryData repositoryData) Create empty instance of a properties builder appropriate for the exported repository data.
Map<String,String>	importBranchData(P repositoryProperties, VcsBranchDefinition existingData) Extract branch configuration from properties object.
Map<String,String>	importBranchDetectionOptions(P repositoryProperties, VcsBranchDetectionOptions existingData) Extract branch detection configuration from properties object.
Map<String,String>	importChangeDetectionOptions(P repositoryProperties, VcsChangeDetectionOptions existingData) Extract change detection configuration from properties object.
Map<String,String>	importLocationData(P repositoryProperties, VcsLocationDefinition existingData) Extract vcs location configuration from properties object.

Method Detail

getEntityPropertiesBuilder

@NotNull
B getEntityPropertiesBuilder(@NotNull
                                      VcsRepositoryData repositoryData)

Create empty instance of a properties builder appropriate for the exported repository data.

Returns:

instance of a builder

appendLocationData

@NotNull
B appendLocationData(@NotNull
                              B builder,
                              @NotNull
                              VcsLocationDefinition vcsLocationDefinition)

Fill in the builder passed as the first argument with vcs server data.

appendBranchData

@NotNull
B appendBranchData(@NotNull
                            B builder,
                            @NotNull
                            VcsBranchDefinition vcsBranchDefinition)

Fill in the builder passed as the first argument with vcs branch data. Return the first argument if not applicable.

appendChangeDetectionOptions

@NotNull
B appendChangeDetectionOptions(@NotNull
                                        B builder,
                                        @NotNull
                                        VcsChangeDetectionOptions changeDetectionOptions)

Fill in the builder passed as the first argument with change detection configuration. Return the first argument if not applicable.

appendBranchDetectionOptions

@NotNull
B appendBranchDetectionOptions(@NotNull
                                        B builder,
                                        @NotNull
                                        VcsBranchDetectionOptions branchDetectionOptions)

Fill in the builder passed as the first argument with branch detection configuration. Return the first argument if not applicable.

importLocationData

@Nullable
Map<String,String> importLocationData(@NotNull
                                                P repositoryProperties,
                                                @Nullable
                                                VcsLocationDefinition existingData)

Extract vcs location configuration from properties object. Should return null if respective data is undefined in properties object. If data is returned, it should be validated for correctness and completeness.

Parameters:

repositoryProperties -

Returns:

importBranchData

@Nullable
Map<String,String> importBranchData(@NotNull
                                              P repositoryProperties,
                                              @Nullable
                                              VcsBranchDefinition existingData)

Extract branch configuration from properties object. Should return null if respective data is undefined in properties object. If data is returned, it should be validated for correctness and completeness.

Parameters:

repositoryProperties -

Returns:

importChangeDetectionOptions

@Nullable
Map<String,String> importChangeDetectionOptions(@NotNull
                                                          P repositoryProperties,
                                                          @Nullable
                                                          VcsChangeDetectionOptions existingData)

Extract change detection configuration from properties object. Should return null if respective data is undefined in properties object. If data is returned, it should be validated for correctness and completeness.

Parameters:

repositoryProperties -

Returns:

importBranchDetectionOptions

@Nullable
Map<String,String> importBranchDetectionOptions(@NotNull
                                                          P repositoryProperties,
                                                          @Nullable
                                                          VcsBranchDetectionOptions existingData)

Extract branch detection configuration from properties object. Should return null if respective data is undefined in properties object. If data is returned, it should be validated for correctness and completeness.

Parameters:

repositoryProperties -

Returns: