Package com.atlassian.bamboo.vcs.viewer.module

Interface VcsRepositoryViewerExporter

All Known Implementing Classes:
DefaultVcsRepositoryViewerExporter, FishEyeRepositoryViewerExporter, GenericRepositoryViewerExporter, NoConfigVcsRepositoryViewerExporter
@ExperimentalApi public interface VcsRepositoryViewerExporter

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable com.atlassian.bamboo.specs.api.builders.repository.viewer.VcsRepositoryViewer
    fromYaml(@NotNull Node node)
    Read YAML node and return VcsRepositoryViewer if found.
    @NotNull com.atlassian.bamboo.specs.api.builders.repository.viewer.VcsRepositoryViewer
    toSpecsEntity(@NotNull VcsRepositoryViewerDefinition viewerDefinition)
    Converts the supplied viewer data and additional configuration to a viewer type-specific properties.
    @NotNull Map<String,String>
    toViewerConfiguration(@NotNull com.atlassian.bamboo.specs.api.model.repository.viewer.VcsRepositoryViewerProperties entityProperties)
    Converts data from importer to Bamboo repository viewer configuration.
    default @Nullable Node
    toYaml(com.atlassian.bamboo.specs.api.model.repository.viewer.VcsRepositoryViewerProperties entityProperties)
    Produce YAML node and return VcsRepositoryViewerProperties configuration.

  • Method Details

    • toViewerConfiguration

      @NotNull @NotNull Map<String,String> toViewerConfiguration(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.repository.viewer.VcsRepositoryViewerProperties entityProperties) throws YamlValidationException
      Converts data from importer to Bamboo repository viewer configuration.
      Throws:
      YamlValidationException

    • toSpecsEntity

      @NotNull @NotNull com.atlassian.bamboo.specs.api.builders.repository.viewer.VcsRepositoryViewer toSpecsEntity(@NotNull @NotNull VcsRepositoryViewerDefinition viewerDefinition)
      Converts the supplied viewer data and additional configuration to a viewer type-specific properties.

    • toYaml

      @Nullable default @Nullable Node toYaml(com.atlassian.bamboo.specs.api.model.repository.viewer.VcsRepositoryViewerProperties entityProperties) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
      Produce YAML node and return VcsRepositoryViewerProperties configuration.
      Parameters:
      entityProperties - settings
      Returns:
      YAML Node which contain representation of Bamboo Specs entity.
      Throws:
      com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
      Since:
      8.1

    • fromYaml

      @Nullable default @Nullable com.atlassian.bamboo.specs.api.builders.repository.viewer.VcsRepositoryViewer fromYaml(@NotNull @NotNull Node node) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
      Read YAML node and return VcsRepositoryViewer if found.
      Parameters:
      node - yaml structure with VcsRepositoryViewer settings
      Returns:
      Specs recipient entity
      Throws:
      com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
      Since:
      8.1