Package 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	Description
CachingHelpUrls(HelpUrlsLoader loader, ResourceBundleCacheCleaner resourceBundleCacheCleaner)

Method Summary

Modifier and Type	Method	Description
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	onClearCacheEvent(ClearCacheEvent cacheEvent)
void	onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)
void	onJiraStartedEvent(JiraStartedEvent event)
void	onLicenseChangedEvent(LicenseChangedEvent 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 Details

CachingHelpUrls

public CachingHelpUrls(HelpUrlsLoader loader,
 ResourceBundleCacheCleaner resourceBundleCacheCleaner)

Method Details

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

onClearCacheEvent

@EventListener
public void onClearCacheEvent(ClearCacheEvent cacheEvent)

onJiraPluginCacheResetEvent

@EventListener
public void onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)

onLicenseChangedEvent

@EventListener
public void onLicenseChangedEvent(LicenseChangedEvent event)

onJiraStartedEvent

@EventListener
public void onJiraStartedEvent(JiraStartedEvent event)