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 and Description
String	getTitle(String key) Retrieve the title for the link to help documentation.
String	getUrl(String key) Constructs a link to the help documentation.

Method Detail

getUrl

@NotNull
String getUrl(@NotNull
                       String key)

Constructs a link to the help documentation. In case the provided key is invalid, this will return a link to the homepage of the documentation.

Parameters:

key - the key to retrieve the documentation link for

Returns:

link to the help documentation

getTitle

@NotNull
String getTitle(@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