public class

CachingHelpUrls

extends Object
implements HelpUrls
java.lang.Object
   ↳ com.atlassian.jira.help.CachingHelpUrls

Summary

Public Constructors
CachingHelpUrls(HelpUrlsLoader loader)
Public Methods
@EventListener void clearCache(ClearCacheEvent cacheEvent)
@Nonnull HelpUrl getDefaultUrl()
Returns a HelpUrl that can be used for generic JIRA help.
@Nonnull HelpUrl getUrl(String key)
Returns a HelpUrl associated with the passed key.
@Nonnull Set<String> getUrlKeys()
Return all the keys that have an associated HelpUrl.
Iterator<HelpUrl> iterator()
@EventListener void jiraStarted(JiraStartedEvent event)
@EventListener void pluginDisabled(PluginDisabledEvent event)
@EventListener void pluginEnabled(PluginEnabledEvent event)
@EventListener void pluginModuleDisabled(PluginModuleDisabledEvent event)
@EventListener void pluginModuleEnabled(PluginModuleEnabledEvent event)
@EventListener void pluginRefreshed(PluginRefreshedEvent event)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.help.HelpUrls
From interface java.lang.Iterable

Public Constructors

public CachingHelpUrls (HelpUrlsLoader loader)

Public Methods

@EventListener public void clearCache (ClearCacheEvent cacheEvent)

@Nonnull public HelpUrl getDefaultUrl ()

Returns a HelpUrl that can be used for generic JIRA help. It commonly points at the JIRA help index/landing page.

Returns
  • the default HelpUrl for this instance.

@Nonnull public HelpUrl getUrl (String key)

Returns a HelpUrl associated with the passed key. The getDefaultUrl() URL is returned if the key has no associated URL.

Parameters
key the key to search for.
Returns
  • the HelpUrl

@Nonnull public Set<String> getUrlKeys ()

Return all the keys that have an associated HelpUrl.

Returns
  • all the keys that have an associated HelpUrl.

public Iterator<HelpUrl> iterator ()

@EventListener public void jiraStarted (JiraStartedEvent event)

@EventListener public void pluginDisabled (PluginDisabledEvent event)

@EventListener public void pluginEnabled (PluginEnabledEvent event)

@EventListener public void pluginModuleDisabled (PluginModuleDisabledEvent event)

@EventListener public void pluginModuleEnabled (PluginModuleEnabledEvent event)

@EventListener public void pluginRefreshed (PluginRefreshedEvent event)