com.atlassian.jira.help

Class CachingHelpUrls

java.lang.Object

com.atlassian.jira.help.CachingHelpUrls

All Implemented Interfaces:

HelpUrls, Iterable<HelpUrl>

public class CachingHelpUrls
extends Object
implements HelpUrls

Since:

v6.2.4

Constructor Summary

Constructors

Constructor and Description
CachingHelpUrls(HelpUrlsLoader loader, ResourceBundleCacheCleaner resourceBundleCacheCleaner)

Method Summary

Modifier and Type	Method and Description
void	clearCache(ClearCacheEvent cacheEvent)
HelpUrl	getDefaultUrl() Returns a HelpUrl that can be used for generic JIRA help.
HelpUrl	getUrl(String key) Returns a HelpUrl associated with the passed key.
HelpUrl	getUrlForApplication(com.atlassian.application.api.ApplicationKey applicationKey, String key) Adds the ability to retrieve HelpUrl specific to an application and key passed in.
Set<String>	getUrlKeys() Return all the keys that have an associated HelpUrl.
Iterator<HelpUrl>	iterator()
void	jiraStarted(JiraStartedEvent event)
void	licenseChanged(LicenseChangedEvent event)
void	pluginDisabled(com.atlassian.plugin.event.events.PluginDisabledEvent event)
void	pluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent event)
void	pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)
void	pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)
void	pluginRefreshed(com.atlassian.plugin.event.events.PluginRefreshedEvent event)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CachingHelpUrls

public CachingHelpUrls(HelpUrlsLoader loader,
                       ResourceBundleCacheCleaner resourceBundleCacheCleaner)

Method Detail

getUrl

@Nonnull
public HelpUrl getUrl(@Nonnull
                               String key)

Description copied from interface: HelpUrls

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

Specified by:

getUrl in interface HelpUrls

Parameters:

key - the key to search for.

Returns:

the HelpUrl

getDefaultUrl

@Nonnull
public HelpUrl getDefaultUrl()

Description copied from interface: HelpUrls

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

Specified by:

getDefaultUrl in interface HelpUrls

Returns:

the default HelpUrl for this instance.

iterator

public Iterator<HelpUrl> iterator()

Specified by:

iterator in interface Iterable<HelpUrl>

getUrlKeys

@Nonnull
public Set<String> getUrlKeys()

Description copied from interface: HelpUrls

Return all the keys that have an associated HelpUrl.

Specified by:

getUrlKeys in interface HelpUrls

Returns:

all the keys that have an associated HelpUrl.

getUrlForApplication

@Nonnull
public HelpUrl getUrlForApplication(@Nonnull
                                             com.atlassian.application.api.ApplicationKey applicationKey,
                                             @Nonnull
                                             String key)

Description copied from interface: HelpUrls

Adds the ability to retrieve HelpUrl specific to an application and key passed in. The HelpUrls.getDefaultUrl() URL is returned if the key has no associated URL.

Specified by:

getUrlForApplication in interface HelpUrls

Parameters:

applicationKey - the application to find help urls for

key - the key to search for.

Returns:

the HelpUrl

clearCache

@EventListener
public void clearCache(ClearCacheEvent cacheEvent)

pluginEnabled

@EventListener
public void pluginEnabled(com.atlassian.plugin.event.events.PluginEnabledEvent event)

pluginDisabled

@EventListener
public void pluginDisabled(com.atlassian.plugin.event.events.PluginDisabledEvent event)

pluginModuleDisabled

@EventListener
public void pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)

pluginModuleEnabled

@EventListener
public void pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)

pluginRefreshed

@EventListener
public void pluginRefreshed(com.atlassian.plugin.event.events.PluginRefreshedEvent event)

licenseChanged

@EventListener
public void licenseChanged(LicenseChangedEvent event)

jiraStarted

@EventListener
public void jiraStarted(JiraStartedEvent event)