com.atlassian.bamboo.utils.i18n

Class DefaultDocumentationLinkProvider

java.lang.Object

com.atlassian.bamboo.utils.i18n.DefaultDocumentationLinkProvider

All Implemented Interfaces:

DocumentationLinkProvider

public class DefaultDocumentationLinkProvider
extends Object
implements DocumentationLinkProvider

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentationLinkProvider(I18nBeanFactory i18nBeanFactory)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDocumentationLinkProvider

@Inject
public DefaultDocumentationLinkProvider(I18nBeanFactory i18nBeanFactory)

Method Detail

postConstruct

@PostConstruct
public void postConstruct()

getUrl

@NotNull
public String getUrl(@NotNull
                              String key)

Description copied from interface: DocumentationLinkProvider

Constructs a link to the help documentation. In case the provided key is invalid, this will return an empty string.

Specified by:

getUrl in interface DocumentationLinkProvider

Parameters:

key - the key to retrieve the documentation link for

Returns:

link to the help documentation

getTitle

@NotNull
public String getTitle(@NotNull
                                String key)

Description copied from interface: DocumentationLinkProvider

Retrieve the title for the link to help documentation. In case the provided key is invalid, the title will be empty.

Specified by:

getTitle in interface DocumentationLinkProvider

Parameters:

key - the key of the help link to retrieve the title for.

Returns:

the title of the help documentation

getAllUrls

@NotNull
public Map<String,String> getAllUrls()

Description copied from interface: DocumentationLinkProvider

Returns an immutable map of all help links keys and actual links to the help documentation.

Specified by:

getAllUrls in interface DocumentationLinkProvider

Returns:

mapping between help link key and its actual url.