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
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CachingHelpUrls
public CachingHelpUrls(HelpUrlsLoader loader)
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 associated an associated
HelpUrl
.
- Specified by:
getUrlKeys
in interface HelpUrls
- Returns:
- all the keys that have associated an associated
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)
jiraStarted
@EventListener
public void jiraStarted(JiraStartedEvent event)
Copyright © 2002-2014 Atlassian. All Rights Reserved.