Package com.atlassian.bamboo.utils.i18n

Interface DocumentationLinkProvider

All Known Implementing Classes:
DefaultDocumentationLinkProvider
public interface DocumentationLinkProvider
Provides utilities around Bamboo documentation, e.g. retrieving the URL of a Bamboo help page in the external Bamboo documentation instance.
Since:
5.10

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Map<String,String>
    getAllUrls()
    Returns an immutable map of all help links keys and actual links to the help documentation.
    @NotNull String
    getTitle(@NotNull String key)
    Retrieve the title for the link to help documentation.
    @NotNull String
    getUrl(@NotNull String key)
    Constructs a link to the help documentation.

  • Method Details

    • getUrl

      @NotNull @NotNull String getUrl(@NotNull @NotNull String key)
      Constructs a link to the help documentation. In case the provided key is invalid, this will return an empty string.
      Parameters:
      key - the key to retrieve the documentation link for
      Returns:
      link to the help documentation

    • getTitle

      @NotNull @NotNull String getTitle(@NotNull @NotNull String key)
      Retrieve the title for the link to help documentation. In case the provided key is invalid, the title will be empty.
      Parameters:
      key - the key of the help link to retrieve the title for.
      Returns:
      the title of the help documentation

    • getAllUrls

      @NotNull @NotNull Map<String,String> getAllUrls()
      Returns an immutable map of all help links keys and actual links to the help documentation.
      Returns:
      mapping between help link key and its actual url.