Constructor and Description |
---|
CachingHelpUrls(HelpUrlsLoader loader,
ResourceBundleCacheCleaner resourceBundleCacheCleaner) |
Modifier and Type | Method and 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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public CachingHelpUrls(HelpUrlsLoader loader, ResourceBundleCacheCleaner resourceBundleCacheCleaner)
@Nonnull public HelpUrl getUrl(@Nonnull String key)
HelpUrls
HelpUrl
associated with the passed key. The HelpUrls.getDefaultUrl()
URL is returned if the key
has no associated URL.@Nonnull public HelpUrl getDefaultUrl()
HelpUrls
HelpUrl
that can be used for generic JIRA help. It commonly points
at the JIRA help index/landing page.getDefaultUrl
in interface HelpUrls
HelpUrl
for this instance.@Nonnull public Set<String> getUrlKeys()
HelpUrls
HelpUrl
.getUrlKeys
in interface HelpUrls
HelpUrl
.@Nonnull public HelpUrl getUrlForApplication(@Nonnull com.atlassian.application.api.ApplicationKey applicationKey, @Nonnull String key)
HelpUrls
HelpUrl
specific to an application and key passed in. The HelpUrls.getDefaultUrl()
URL is returned if the key
has no associated URL.getUrlForApplication
in interface HelpUrls
applicationKey
- the application to find help urls forkey
- the key to search for.HelpUrl
@EventListener public void onClearCacheEvent(ClearCacheEvent cacheEvent)
@EventListener public void onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)
@EventListener public void onLicenseChangedEvent(LicenseChangedEvent event)
@EventListener public void onJiraStartedEvent(JiraStartedEvent event)
Copyright © 2002-2019 Atlassian. All Rights Reserved.