public class

DefaultHelpUrlsLoader

extends Object
implements HelpUrlsLoader
java.lang.Object
   ↳ com.atlassian.jira.help.DefaultHelpUrlsLoader

Summary

Public Constructors
DefaultHelpUrlsLoader(HelpResourceBundleLoader helpResourceBundleLoader, JiraAuthenticationContext ctx, LocalHelpUrls localHelpUrls, I18nHelper.BeanFactory i18n, HelpUrlsParserBuilderFactory parserBuilderFactory, HelpUrlsApplicationKeyProvider helpUrlsApplicationKeyProvider, ApplicationHelpSpaceProvider applicationHelpSpaceProvider)
Public Methods
HelpUrls apply(HelpUrlsLoader.HelpUrlsLoaderKey input)
Return the HelpUrls associated with the passed HelpUrlsLoader.HelpUrlsLoaderKey.
@Nonnull HelpUrlsLoader.HelpUrlsLoaderKey keyForApplication(ApplicationKey applicationKey)
Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the application key provided.
@Nonnull HelpUrlsLoader.HelpUrlsLoaderKey keyForCurrentUser()
Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the calling user.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.help.HelpUrlsLoader
From interface com.google.common.base.Function

Public Constructors

public DefaultHelpUrlsLoader (HelpResourceBundleLoader helpResourceBundleLoader, JiraAuthenticationContext ctx, LocalHelpUrls localHelpUrls, I18nHelper.BeanFactory i18n, HelpUrlsParserBuilderFactory parserBuilderFactory, HelpUrlsApplicationKeyProvider helpUrlsApplicationKeyProvider, ApplicationHelpSpaceProvider applicationHelpSpaceProvider)

Public Methods

public HelpUrls apply (HelpUrlsLoader.HelpUrlsLoaderKey input)

Return the HelpUrls associated with the passed HelpUrlsLoader.HelpUrlsLoaderKey. The passed HelpUrlsLoaderKey must have been returned from a previous call to keyForCurrentUser() on this instance. It is not safe to use HelpUrlsLoaderKey across instances of HelpUrlsLoader.

Parameters
input the HelpUrlsLoaderKey to query for. It must have been returned from a keyForCurrentUser() on this instance. Using HelpUrlsLoaderKey from other instances may result in runtime exceptions.
Returns
  • the HelpUrls associated with the passed key.

@Nonnull public HelpUrlsLoader.HelpUrlsLoaderKey keyForApplication (ApplicationKey applicationKey)

Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the application key provided. It can safely be used as a key to cache the result of a HelpUrls lookup.

Returns
  • the loader key associated with the passed application.

@Nonnull public HelpUrlsLoader.HelpUrlsLoaderKey keyForCurrentUser ()

Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the calling user. It can safely be used as a key to cache the result of a HelpUrls lookup.

Returns
  • the loader key associated with the calling user.